Request an access token

Exchanges an OAuth 2.0 grant for an access token and, when applicable, a refresh token.

POST/connect/token

Exchanges an OAuth 2.0 grant for an access token and, when applicable, a refresh token.

Request Body

application/x-www-form-urlencoded

TypeScript Definitions

Use the request body type in TypeScript.

grant_type*string

OAuth 2.0 grant type.

Value in

"client_credentials"
"password"
"authorization_code"
"refresh_token"

client_id*string

OAuth application client ID.

client_secret?string

OAuth application secret. Required for confidential clients.

scope?string

Space-separated OAuth scopes.

username?string

User email for the password grant.

password?string

User password for the password grant.

Formatpassword

refresh_token?string

Refresh token for the refresh_token grant.

code?string

Authorization code returned by /connect/authorize. Required for the authorization_code grant.

redirect_uri?string

Redirect URI used in the authorization request, when that request included one.

Formaturi

code_verifier?string

PKCE verifier. Required for the authorization_code grant.

identity_scope?string

Identity scope for the password grant. Defaults to global.

Value in

"global"
"tenant"
"store"

tenant_id?string

Organization identifier. Required with tenant or store identity scope.

store_id?string

Store identifier. Required with store identity scope.

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/connect/token" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'grant_type=client_credentials&client_id=app_replace_with_your_client_id&client_secret=replace_with_your_client_secret&scope=api_admin'

{  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",  "token_type": "Bearer",  "expires_in": 3600,  "scope": "api_admin"}

Request an access token

Request Body

Response Body

200application/json

400application/json

401application/json

403application/problem+json

404application/problem+json

500application/problem+json

`application/json`

`application/json`

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`