API ReferenceSystem Credentials

Create Credentials

Create new system-level credentials. System-level credentials are not tied to a specific user and never expire.

The access of the system-level credentials are scoped to the specified roles. If no roles are provided, the system-level credentials will have full access to all resources.

The client id and client secret of the created credentials can be exchanged for access tokens which can be used to make requests to the API. These credentials should only be used for programmatic access to the API as they are not tied to a specific user.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired

Display name for the system-level credentials

roleslist of objectsOptional

List of roles to assign to the system-level credentials. This is only available to organizations that are RBAC-enabled. Please contact support if you would like to enable RBAC for your organization.

Response

The details of the created system-level credentials, including the client ID and secret

client_idstring
OAuth client ID
client_secretstring

OAuth client secret (only returned on creation)

namestring
Display name for the OAuth client
roleslist of objects
List of roles assigned to the client

Errors