Application Keys

Overview Copied

The Application keys page allows you to connect to external applications securely using OAuth 2.0. You can use this page to manage OAuth 2.0 client credentials.

For more information about OAuth 2.0, see the OAuth documentation.

API key credentials are composed of a client_id and a client_secret. These can be used by an external application to authenticate their identity with Gateway Hub before requesting authorisation to access data. You can create new API key credentials, regenerate the client_secret associated with an identity, or remove API key credentials.

API keys assign an external application a set Gateway Hub roles that determine which resources it can view and edit. For more information, see Roles.

You cannot edit security settings from an external application using a API key. You must use the Web Console interface.

Create API keys Copied

To create a new set of API keys:

1. Click New API Key. This opens the New API Key window.
2. Specify the Name of the identity associated with this set of API keys.
3. Click, Next. Specify one or more Gateway Hub roles. This determines which Gateway Hub resources an application using this API key can read or write.
4. Click Generate API Key. This displays the new API Keys.
5. Copy the client_id and client_secret keys and store them securely.
6. Click Close.

Caution

You cannot recover API keys once you have closed the New API Key window.

Regenerate Copied

To regenerate the API key credentials associated with an identity:

1. Hover the cursor over an identity. This shows the regenerate and delete options.
2. Click Regenerate. This opens the Regenerate API key window.
3. Click Regenerate API key. This displays the new API Keys.
4. Copy the client_id and client_secret keys and store them securely.
5. Click Close.

Delete API keys Copied

To delete the API key credentials associated with an identity:

1. Hover the cursor over an identity. This shows the regenerate and delete options.
2. Click Delete.

Caution

Delete operations are permanent and cannot be undone.