Creating and Revoking API Client Credentials

About this task

Before external applications can access the SOTI XSight API, you must first generate a client ID and client secret. External application use the client ID and secret to authenticate themselves to the SOTI XSight API.

To create SOTI XSight API client credentials:

Procedure

  1. Log in to the SOTI XSight web console as administrator.
  2. In the top-left corner of the console, select Main Menu Main menu button and then select Settings . The Settings menu opens.
  3. In the Settings menu, select Integration and then select API Clients. The API Clients view opens.
  4. In the API Clients view, select Add API Clients Add button. The Add API Client panel opens.
  5. In the Add API Client panel, enter a name and the redirect URL of the API client.
  6. Select Generate Credentials. The generated client ID and secret appear in the Add API Client panel.
  7. Optional: Select Copy ID Copy button to copy the client ID to the clipboard. You can also copy the client ID from the Integration section later.
  8. Select Copy Secret Copy secret to copy the client secret to the clipboard. Save the client secret in a secure file.
    Warning: This is the only opportunity to see and copy the client secret. Once you close the Add API Client panel, you cannot retrieve it.
  9. Select OK to close the Add API Client panel. The new API client gets added to the list of clients in the API Clients view.

Results

You have generated the client ID and secret.

What to do next

Send the client ID and secret to the external application's administrator so they can access the API.

Revoking API Client Credentials

About this task

To revoke SOTI XSight API client credentials:

Procedure

  1. Log into SOTI XSight as an administrator.
  2. On the menu bar, select the menu button Menu buttonand select Settings. The Settings view opens.
  3. On the left side of the settings view, select Integration.
  4. Select on API Clients. The API Clients section opens on the right side.
  5. Select an API client name from the list then select Delete Button to the right of your selection. The Delete API Client dialog box opens.
  6. In the Delete API Client dialog box, select Yes, please delete this API client, then select Delete. This removes the API client credentials from the list.