API Access Control

API access can be disabled for an API client, customer group, or an AMM user.

Disabling an API Client

Follow the steps below to disable an API client:

1. Select Develop->API Clients.

2. Select the name of the API client that you wish to disable.

3. Uncheck the Access Enabled checkbox.

4. Select Save.

Disabling a Customer Group

Follow the steps below to disable a Customer Group:

1. Select Develop->API Group Usage Control.

2. Select the name of the Group that you wish to disable.

3. Uncheck the Access Enabled checkbox.

4. Select Save.

Disabling an AMM User

Follow the steps below to disable an AMM User:

1. Select Develop->API User Access Control.

2. Select the name of the User that you wish to disable.

3. Uncheck the Access Enabled checkbox.

4. Select Save.

Note: Disabling API access on a remote user group will disable API access for all remote users under the group.

Response when access is disabled

If a request is rejected due to access being disabled, the standard HTTP “403 forbidden” response is returned back to caller with an error message. The error message will indicate the customer group, client, or user whose access is disabled:

{
"error": "access_denied",
"error_description": "Access is disabled for client: CLIENT_ID" 
}