Manage API clients

The API Integration page lets you manage API clients. You must create an API client to authenticate any API calls you or developers make.

To learn more, see the Knox Manage API reference.

Add an API client

To add an API client:

1. Navigate to the API Integration page.

2. Click ADD API CLIENT.

3. On the Add API client page that opens, enter the following:

   • Client ID — Assign a unique client ID. This must be under 50 characters.
   • Client secret — Enter a password between 8 and 30 characters. The password must be a combination of letters, numbers, and at least one special character.
   • Token validity period — Set the access time in seconds for how long the authentication token is valid for.
   • Permission Level — Set the client’s permission levels. You can grant them Can edit or Read only access. Read only clients can only make GET calls.

   

4. Click ADD.

You can generate as many clients as needed, but only five can have an active status at a time. If you already have five active clients, any clients you add automatically have an inactive status. To free up spots for new active clients, change the status of existing clients.

To activate or deactivate a client, select it and click ACTIONS > Change status. The status of the API client changes to Active or Inactive depending on its previous status.

Any client with an inactive status can’t be used for authentication until you move it back to an active state.

View API clients

To view your API clients, you must search for the clients you want to view. Enter a client ID in the search bar, then click SEARCH. All relevant search results appear.

You can also view the activity logs to learn more about the authentication and generation history of your API clients. See Review the activity logs for more information.

Invalidate a token

An invalidated token cannot be used again. If you call the Knox Manage API with an invalidated token, an error message shows and the API call is disabled and you must generate a new token. To learn more, see the Knox Manage API reference.

To invalidate tokens, complete the following steps:

1. Select an API client or clients, then click ACTIONS > Invalidate token.
2. On the window that opens, click INVALIDATE.

Duplicate an API client

You can duplicate an existing API client to create a new client with the same token validity period and permission. When you duplicate a client, you can’t copy its client ID or client secret to the new client.

To duplicate an API client:

1. Select an API client, then click ACTIONS > Duplicate API client.
2. On the Add API Client page that opens, enter the following:
   • Client ID — Assign a unique client ID to use for a token request.
   • Client secret — Enter a password between 8 and 30 characters. The password must be a combination of letters, numbers, and special characters.
3. Click ADD.

Edit an API client

You can edit the information of an existing API client. To edit an API client:

1. Select a client. Then click ACTIONS > Edit API client.
2. On the Edit API Client page that opens, you can modify the following client information:
   • Client ID
   • Token validity period
   • Permission Level
3. Click Save.

Delete an API client

To delete an API client:

1. Select an API client or clients, then click ACTIONS > Delete API client(s).
2. On the Delete API client(s) window that opens, click DELETE.