For more information on how to create new machine accounts or to migrate your old machine accounts to the Token-based Authentication method, please refer to this article here or download this PDF.

 

This article explains the following aspects of managing your machine accounts:

1. Renaming machine accounts

2. Deleting machine accounts

3. Changing machine account settings

4. Bulk actions

5. Resetting Client secret

6. Managing properties including addition, removing, etc.

7. Managing IP allowlist

8. Retrieving messages from Messaging API

Managing your machine accounts

Renaming machine accounts

You can rename Token based machine accounts, but they should all have unique names. 

To rename your machine account:

1. Go to the ‘Token machine accounts’ page and select the 3 dots on the right-hand side. 

2. Select ‘Rename’

3. Select ‘Update’
   

Deleting machine accounts

It is possible to delete Token based machine accounts, but this is only possible for disabled machine accounts.

To delete a machine account:

1. Go to the ‘token machine accounts’ page and select the 3 dots on the right-hand side of the page

2. Select ‘Disable’ account to delete.

3. After disabling, select ‘Delete’

 Please note that deleted machine accounts cannot be recovered and any associated configurations and data will also be lost.

 

Changing settings

You can change settings to add new properties to a machine account either automatically or manually.

To change settings:

1. Go to the ‘Token machine accounts’ page and select the 3 dots on the right-hand side of the page.

2. Select ‘Change settings’.

3. Turning on ‘Assign new properties to this machine account’, it automatically associates the new properties that are connected to you as the provider with this machine account. If you onboard many new properties, you don’t have to manually associate them with the machine account to start using our APIs.

4. ‘Disable/enable machine account’ turns the machine account on or off. If you disable a machine account, everything (properties, IPs, settings) stays saved.
   

Bulk actions

The enable, disable, delete and reset actions above can also be performed in bulk for multiple Token based machine accounts by using the "Bulk actions" button.

 

Reset client secret

In each machine account page it’s possible to reset the client secret by clicking on the dedicated button and following the flow.

Note: As the new client secret is generated, the old one will immediately stop working.

 

Managing properties

Adding properties

1. Select ‘Machine account overview’ for the machine account for which you want to add properties

2. Select ‘Add property’

3. Paste property ID(s)

4. As an alternative, you can select ‘Add all active properties’ to automatically populate the field with all the XML_active properties IDs.
   

Remove properties

1. Select one or more property IDs by selecting the checkboxes

2. Select ‘Remove from list’ to remove

Unassigned properties section

This section lists all your properties currently not assigned to any machine account. If you don’t take any action, you won’t be able to make any changes to them.

You can add them to one or more machine accounts by following the steps above to fix it.

 

Did you already set up the new machine accounts? Refer to this migration guide for more details on how to Use the ‘Client secrets’ in the Provider Portal to generate a temporary token for these accounts and Using the temporary token to access our APIs.

 

Important: Managing IP allowlist

Nothing changed in the way you whitelist IPs.

IP allowlisting is not mandatory for Token based machine accounts, while it remains mandatory for basic authentication accounts. 

1. If you don’t specify any IP, no filter will be applied.

2. If you still prefer to add IPs to the allowlist, you can do so by​​ selecting ‘Add IP allowlist’.

3. You can see and manage IPs already added from the IP allowlist tab.

Note: If you add at least one IP address to the list, the filter will be active, and we’ll accept requests coming ONLY from the address(es) on this list.

To remove the filter, you will need to remove all the IPs on this list.

 

Receiving messages from Messaging API

Messaging API certified providers can define which of their new machine accounts can have access to the /messaging/messages/latest endpoint of the API. They can do this by selecting or deselecting the option to do this in the Provider Portal. If you are not using the Messaging API, you can skip this step.

Read more about this change here and refer to the screenshot below for visual depiction of how this setting can be enabled in the machine account page of the Portal