Generate REST API Access Key

Overview

Gainsight uses the API Access key and M2M OAuth to authenticate REST API requests securely. Admins can generate the API keys that developers use in the request headers to access Gainsight services.

Limitations:

• Only one Access key can be created per organization.
• A maximum of 15 M2M OAuth keys can be created per organization.

Gainsight authenticates the REST API requests by verifying the key. If authentication succeeds, developers gain access to the Gainsight platform via REST APIs.

You can reset the existing access keys anytime. However, ensure the new key is updated in all future API request headers.

Generate Access Key

To interact with Gainsight APIs, developers need an Access Key for authentication. To generate the Access key:

1. Navigate to the Administration > Connectors 2.0.
2. Click Create Connection. The Create Connection dialog box appears.
3. From the Connector dropdown list, select Gainsight API.
4. In the Name of the connection field, enter the name of the connection.
5. In the Authentication Type, select the Access_Key.
6. Click Generate Access Key.

A new access key is generated which you can copy and use for authentication in all REST API requests to Gainsight.

Edit Gainsight API Connection

Admins can edit the Gainsight API Connection to reset the existing API access key.

To reset the existing API access key:

1. Click the three vertical dots of the created Connection and select Edit Connection. The Edit Connection dialog appears.
2. Click Re-Generate Access Key to generate a new access key.
3. Click Re-Generate on the confirmation message.

A new access key is generated, which you can copy and use for authentication in all future REST API requests to Gainsight.

Note: The new access key should be replaced in the headers of all future API requests. If it is not replaced, all future API requests to the specific Gainsight org will fail.