v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

OAuth

Create OAuth 2.0 access token

This endpoint is an OAuth 2.0 <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-3.2">token endpoint</a> and can be used by a client to obtain an access token.

Use <a href="https://app.atlar.com/users/all">programmatic access user</a> credentials as OAuth 2.0 client credentials. Use the <i>access key</i> as <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-2.2">client identifier (client_id)</a>. Use the <i>secret</i> as <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-2.3.1">client password (client_secret)</a>.

This endpoint supports <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-2.3.1">authentication using HTTP Basic auth</a>.

Supported grant types: <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.4">client_credentials</a> for programmatic access users.

<a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1">authorization_code</a> (with PKCE) and <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-6">refresh_token</a> for MCP CIMD clients.

post/iam/v2/oauth2/token

Response

Successful OAuth 2.0 <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.4.3">access token response</a>.

access_tokenstring required

token_typestring required

expires_ininteger

The lifetime in seconds of the access token.

refresh_tokenstring

Opaque <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-1.5">OAuth 2.0 refresh token</a> that the client can use to obtain a new access token. Only present when the authorization server issued one for the grant.

Example response

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.Xi9Rplok2DNmNGBPC1CMxUY-ZBkzY-g-sxqzKkWjViU",
  "token_type": "Bearer",
  "expires_in": 299
}