Creating API Client Credentials

About this task

Before you can authorize an external application to access the SOTI Assist API, you must first generate a client ID and a client secret that the external application can use to authenticate itself to the SOTI Assist API.

To create SOTI Assist API client credentials:

Procedure

  1. Log into SOTI Assist as an administrator.
  2. On the menu bar, click the menu button and select Settings.
    The SOTI Assist settings page opens.
  3. On the left side of the settings page, click Integration.
    The Integration section opens on the right side.
  4. At the bottom of the Integration section, under SOTI Assist Integration, click the green + button next to Add API Clients.
    The Add API Client dialog box opens.
  5. In the Add API Client dialog box, enter a name and the redirect URL for the API client, then click Add & Generate Credentials.
    The generated client ID and client secret appear in the Add API Client dialog box.
  6. Optional: Click the Copy ID button to copy the client ID to the clipboard.
    You can also copy the client ID later when it is listed in the Integration section.
  7. Required: Click the Copy Secret button to copy the client secret to the clipboard. Ensure that you paste the client secret into a secure file.
    Warning: This is the only opportunity to see and copy the client secret. Once you close the Add API Client dialog box, you will no longer be able to see the client secret.
  8. Click Done to close the Add API Client dialog box and return to the Integration section of the setting page.
    The new API client is added to the list of clients under SOTI Assist Integration.

Results

Once the client ID and client secret have been generated, you can send them to the external application's administrator so that the application can use them to access the SOTI Assist API.

For more information, see the Authentication topic in the SOTI Assist API documentation.