Skip to navigation
Sigma REST APICredentials

Create API credentials

View as Markdown

Create API client credentials for a given user. To make this request, your API client credentials must be associated with a Sigma admin user for the same Sigma organization.

Important: The response includes sensitive information. Ensure that you securely store and handle the returned clientId and clientSecret. These credentials grant access to your Sigma account and should never be exposed publicly or shared unnecessarily.

Usage Notes:

  • Retrieve the ownerId by calling the /v2/members endpoint and using the memberId included in the response.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
ownerIdstringRequired
Unique identifier of the user.
namestringRequired
Name of the credentials.
descriptionstringOptional
Description of the credentials
scopeslist of enumsOptional
Scopes to assign to the credentials. If not provided, defaults to "api".
Allowed values:

Response

The response body.
clientIdstring
clientSecretstring