API Keys

The API keys tab is accessed from the Dashboard . This is where management of API Keys is handled 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, reinstated or deleted to securely control access. The API Key name will be used in place of a username in 1Integrate metadata.

     Warning: 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 Dashboard of the 1Integrate interface.

    API Keys tab of the dashboard

  2. Click the Add icon and provide a Name, Description (optional), and select the Permissions that the key will provide access to.

         Note: You can only select Permissions that your User profile has access to.

    For information on Permissions, please refer to Configuring Users and Permissions.

  3. Click Confirm. A new API key will have now been generated.

    Propmt to copy API Key

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

ClosedManaging Keys

Once created, a Key can be edited, revoked/reinstated, or deleted.

Edit

Clicking the Edit icon allows you to change the Name, Description, Roles assigned to a API Key. Click Confirm to save any changes.

Revoke/Reinstate

Click Revoke to cause the API Key to lose access to the permissions it has been assigned. The Key will appear as the image below to show that it has been revoked.

Revoked Key

This can be reversed by clicking Reinstate.

Delete

Clicking the Delete icon lets you delete an API Key. You will be warned that it isn't recoverable once deleted and will need to confirm deletion by clicking Delete API Key. This can be done to any Key include those that are not revoked.

Delete API Key popout

ClosedPerforming Batch Actions

Batch Actions allow you to perform an action on all API keys at once. Click batch options, and select one of the following options.

Option

Description

Revoke All API keys

Revokes the provision of all generated API keys. Anyone using the API key will no longer have access.

Reinstate all API keys

This reinstates the provisions of any revoked API keys.

Delete all revoked API keys

Completely removes any revoked API Keys.

     Warning: Once deleted they cannot be reinstated.