Creating API key accounts

You create API key accounts to enable external scripts or apps to authenticate to the application through the REST API.

Before you begin

For more detailed information about creating API key accounts in a non-MSSP account, see API key accounts.

About this task

Important: Only App API key accounts are supported in Standard accounts. The App key accounts are created automatically by the apps.

For non-App API key accounts, you create them in the Provider account and select the Standard accounts to which you want to grant the API key access.

Procedure

  1. From the Provider account menu, click Application settings > Case Management > Permissions and Access.
  2. Click Users > API Keys.
  3. Click Create API Key.
  4. From the Create API Key screen, enter the display name for the API key account. This must be unique in the account. This is the name for the key that is shown on the Administrator Settings > Users > API Keys tab. Optionally, you can enter a description.
  5. From the Organizations field, select the Standard accounts to which you want to grant the API key account access.
  6. From the Permissions section, assign the required permissions for the API key that you are creating.
  7. Click Create. The API key credentials are displayed.
  8. Make a note of the credentials and store them safely as you cannot retrieve them after you click OK. Then click OK to proceed.

Results

The API Key Account is created. To subsequently change the permissions, display name or description, navigate to Administrator Settings > Users > API Keys, select the key that you want to edit, and click Edit. From the editor, change the permissions or display name, as required.

If you need to regenerate the key, click Regenerate API Key Secret. The ID remains the same but a new secret is generated. Any scripts or external apps that are using the API key account must be updated to match the regenerated key. To delete the key, click Regenerate API Key Secret > Delete API Key.