API Keys

The API keys tab allows for the management of API Keys within the 1Integrate interface.

API keys can be used by software accessing the 1Integrate REST API, instead of creating specific service users to authenticate via usernames and passwords. Keys can be temporarily revoked or reinstated to securely control access. The API key name will be used in place of username in 1Integrate metadata.

Note: For security reasons the key must be copied at creation time as the key value will not be accessible after that time.

Note: API keys are valid for all REST operations (dependant on roles assigned), except for any API key management ones.

ClosedGenerating a new API Key

  1. Navigate to the API Keys tab from the Admin section of the 1Integrate interface.

    The API Keys user interface in the admin section.

  2. Select the plus icon and provide a Name, Description (optional) and the Roles the key will have access to.

    For information on roles, please refer to Configuring Users and Roles.

    API Key configuration options

  3. A new API key will have now been generated. Be sure to copy the API key at this point, for security purposes it will not be available again.

ClosedManaging Keys

Once you have created a key you can manage it by selecting the settings icon .

Option Description
Edit Select edit to change the details of the key and adjust the roles.
Revoke

Select to revoke the key.

Revoked keys will appear as dark grey in the UI with a blocked icon .

Revoked keys cannot be used until reinstated, but are not completely removed from the system, unlike a deleted key.

Reinstate Select this option to reinstate a revoked key.
Delete Delete a key to remove it completely. Deleted keys cannot be reinstated and are permanently removed.

ClosedPerforming Batch Actions

You can perform a number of options to all API keys at once, these are called batch actions. To perform batch options, select the Batch Actions icon.

Once selected you will have the following options:

Option Description
Revoke All API keys Select to revoke the provision of all generated API keys. Anyone using the API key will no longer have access.
Reinstate all API keys Selecting this option will reinstate any previously revoked API keys.
Delete all revoked API keys Completely remove any API Keys that are currently revoked. Once deleted they cannot be reinstated.