SIsigmacomputing
Auth

Get access token

Use your Sigma client ID and secret with this endpoint to generate an access token valid for one hour, or to refresh your token. You can then use the access token to authenticate requests made to the Sigma API.

To make any API call with the Sigma API, including calls from the API documentation, you must have a valid bearer token. To generate a token, you must have a valid Client ID and Secret. See Generate Sigma API client credentials.

You make all API calls to a specific URL that corresponds to the cloud where your Sigma environment is hosted. Set the Base URL to the relevant URL for your environment. For details, see Identify your API request URL.

Generate a token by sending a POST request to this /v2/auth/token endpoint, or use the Try It! option on this page.

Usage notes

  • The API token is valid for 1 hour. When the token expires, an endpoint response returns an unauthorized error.
  • Refresh your access token before it expires using the refresh_token option.
  • If your client credentials are owned by a user assigned the Admin account type, you can generate an access token as a specific user using impersonation.
  • By default, the token is granted the api:access scope. To use the token with the Sigma MCP server, include the mcp:access scope in your request (Beta).
post/v2/auth/token

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Request body

grant_type'client_credentials' required

Set to client_credentials to retrieve an access token.

client_idstring required

Your API client ID.

client_secretstring password required

Your API client secret.

scopestring

The scopes to request for the token. Request api:access to access the Sigma REST API, mcp:access to access the Sigma MCP server, or send both scopes, space-delimited, to use one token for both. Defaults to api:access when omitted. On refresh, emits the originally granted scopes.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Response

The response body.

access_tokenstring required

Token used to access the API and make requests.

refresh_tokenstring

Refresh token used to refresh the access token.

token_typestring required

The type of token issued.

expires_ininteger required

The number of seconds until the access token expires.

scopestring

Space-delimited scopes granted to this token.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Changes

No recorded changes to this operation across all 1 revision of this API.