Manage API clients

Add and manage API clients via Knox Manage. Management of API clients includes copying, modifying, deleting, and activating or deactivating API client accounts.

Viewing API clients

Navigate to Advanced > EMM API > API Client to view all the client information on the API Client page.

To view detailed information of a specific API client, click the client ID of a specific API client on the list.

Adding API clients

To add an API client, complete the following steps:

1. Navigate to Advanced > EMM API > API Client.

2. On the API Client page, click Add.

3. In the Add API Client window, enter the following API client information:

   • Client ID — Assign a unique client ID to use for a token request.
   • Password — Enter a new password between 8 and 30 characters. The password must be a combination of letters, numbers, and special characters.
   • Token Validity(sec) — Enter the access time for when the Open API is called.
   • API Permission Level — Grant the client either Management or Read Only permissions. Read-only clients can only call the GET method of operations, and can’t register any changes.

4. Click Save.

Copying API clients

Copy an existing API client and create a new API client. When you reuse a client information, you cannot load the client ID and password of the existing API client.

To copy an API client, complete the following steps:

1. Navigate to Advanced > EMM API > API Client.

2. On the API Client page, click the check box for the API client you want to copy, and the click Copy.

3. In the Copy API Client window, enter the following API client information:

   • Client ID — Assign a unique client ID to use for a token request. The API client ID cannot be modified.
   • Password — Enter a new password between 8 and 30 characters. The password must be a combination of letters, numbers, and special characters.
   • Token Validity(sec) — Displays the copied access time for when the Open API is called.
   • API Permission Level — Grant the client either Management or Read Only permissions. Read-only clients can only call the GET method of operations, and can’t register any changes.

4. Click Save.

Modifying API clients

You can modify the information of an existing API client.

To modify an API client, complete the following steps:

1. Navigate to Advanced > EMM API > API Client.
2. On the API Client page, click the check box for the API client you want to modify the information of, and the click Modify.
3. In the Modify API Client window, modify the following client information:
   1. Client ID — Displays the API client ID.
   2. Password — Modify the password between 8 and 30 characters. The password must be a combination of letters, numbers, and special characters.
   3. Token Validity(sec) — Modify access time for when the Open API is called.
   4. API Permission Level — Grant the client either Management or Read Only permissions. Read-only clients can only call the GET method of operations, and can’t register any changes.
4. Click Save.

Deleting API clients

You can delete API clients from the list.

To delete an API client, complete the following steps:

1. Navigate to Advanced > EMM API > API Client.
2. On the API Client page, click the check box for the API client you want to delete from the list, and the click Delete.
3. In the Delete window, click OK.

Activating or deactivating API clients

To activate or deactivate API client, complete the following steps:

1. Navigate to Advanced > EMM API > API Client.
2. On the API Client page, click the check box for the API client you want to activate or deactivate, and the click Change Status.
3. In the Change Status window, click OK.

The status of the API client changes to Active or Inactive depending on its previous status. Once activated, the Open API can be called using the API client. Once deactivated, the Open API cannot be called using the API client.