Creating API key accounts

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

About this task

When you create the API key account, the account is created in the configuration organization as well as any other organizations that you specify.

For more detailed information about creating API keys, see API key accounts.

1. In the configuration organization, navigate to the Administrator Settings > Users tab.
2. Click API Keys.
3. Click the Create API Key button.
4. From the Create API Key screen, enter the display name for the API key account. This must be unique in the organization. This is the name for the key that is shown on the Administrator Settings > Users > API Keys tab. Optionally, you can enter a description. From the Permissions section, assign the required permissions for the API key that you are creating.
5. Click Create. The API key credentials are displayed.
6. 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 apps that are using the key account must be updated to match the regenerated key. To delete the key, click Regenerate API Key Secret > Delete API Key.