Generate REST API 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.

Generate M2M OAuth Key

To generate the M2M OAuth key:

1. Navigate to Administration > Connectors 2.0.
2. Click Create Connection. The Create Connection dialog 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 OAuth.
6. Click Generate OAuth Credentials.

New OAuth API Key and OAuth API Secret keys are generated, which you can copy and use for authentication in all of the REST API requests to Gainsight.

Note:

• M2M OAuth can be created and managed only by super admins.
• M2M OAuth cannot be used for Event APIs.
• Two different M2M connections cannot have the same name for a single connection.

Admins can also generate and validate tokens for M2M authentication. For more information, refer to the section below.

Generate and Validate Tokens

API Scopes:

• GET APIs: Available for both super admins and non-super admins.
• Create, Update, and Patch APIs: Available only to super admins.

https://<<tenant-url>>/v1/users/m2m/oauth/token

{
      "access_token": "<<access_token value>>",
      "token_type": "Bearer",
      "expires_in": 86400
  } 

https://<<tenant-url>>/v1/users/m2m/oauth/token/introspect

{
      "access_token": "XXXXXXXXX"
} 

{
  "active": true,
  "client_id": "XXXXXX",
  "token_type": "Bearer",
  "exp": 1729123263000
} 

{
"requestId": "170a3a0b-bfe4-4337-a961-a24196925d8b",
"error": "unauthorized"
}