How to Change the Identity REST API Port (version 24)

By default, the Identity service is set to listen on 55353 for inbound client applications (e.g. Axiom, Excel Add-in, and Admin) trying to authenticate. If needing to change this port number, the following steps must be taken.

Preferred Method

On all machines remote from where the Identity service is installed:

1. Open the Canary Admin client and navigate to the Admin tile>Settings screen.
2. Edit the Identity REST Endpoint to include the new port number then APPLY changes.

   

    

On the machine where the Identity service is installed:

1. Repeat steps from above.
2. Navigate to the Identity tile>Configuration>Endpoints screen.
3. Edit the REST API port number then APPLY changes.

   

    

The machine with the Identity service must be done last. Otherwise, the following alternate method must be used which is not the recommended method.

Alternate Method (not preferred)

On the machine where the Identity service is installed:

1. Open the Canary Admin client and navigate to the Identity tile>Configuration>Endpoints screen.
2. Edit the REST API port number then APPLY changes.

   

    
3. Navigate to the Admin tile>Settings screen.
4. Edit the Identity REST Endpoint to include the new port number then APPLY changes.

   

    

On all machines remote from where the Identity service is installed:

1. Go to C:\ProgramData\Canary\Node (or wherever Canary's program data folder is located).
2. Open the node.json file.
3. Edit the IdentityClientEndpointOIDC parameter to include the new port number.