API users

API users
List of API keys that can be used to interact with the BlackNoise solution


Only people with an Administrator role can manage API keys within their organization.


API token list

The list provides several key pieces of information:
  • Token name
  • Truncated API key value
  • Date of API token creation
  • Date of last API request

The API keys list can be exported as a .csv file.


API token creation

To create an API token:
    Click on the Create API user button.
    Enter the token name.
    Save
The web app will provide you with the complete API key value. Make sure to copy and store it securely; you will need this value to use the API. The full value will never be displayed again. When you click on an API token, you will receive the truncated value.


API token modification

When editing an API token, you can:
  • Change the key value by using the Generate new key button. Your current API key will be revoked and a new one will be generated.
  • Disable the API token by switching off the User active option. The token will no longer be able to connect, but the account will be preserved for later reactivation.
  • Delete the API token using the Delete API user button; all profile information will be removed.
Click on the Save button to activate these changes.