Obtain an access token

Obtain a new OAuth 2.0 access token using an OAuth 2.0 client ID/secret pair.

application/x-www-form-urlencoded

Request Body

oneOf

• MOD1
• MOD2
• MOD3

---

scope string

List of OAuth2 scopes, delimited with spaces.

grant_type string required

Possible values: [client_credentials, authorization_code, refresh_token]

grant_type string required

Possible values: [client_credentials, authorization_code, refresh_token]

code string required

redirect_uri string required

client_id string required

The client identifier.

client_secret string

The client secret key.

code_challenge string

grant_type string required

Possible values: [client_credentials, authorization_code, refresh_token]

refresh_token string required

scope string

List of OAuth2 scopes, delimited with spaces.

Responses

• 200
• 400
• 403

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

oneOf

• MOD1
• MOD2
• MOD3

---

access_token string

expires_in integer

Number of seconds until the token expires.

scope string

List of OAuth2 scopes, delimited with spaces.

token_type string

Possible values: [bearer]

access_token string

refresh_token string

id_token string

expires_in integer

Number of seconds until the token expires.

scope string

List of OAuth2 scopes, delimited with spaces.

token_type string

Possible values: [bearer]

access_token string

refresh_token string

id_token string

expires_in integer

Number of seconds until the token expires.

scope string

List of OAuth2 scopes, delimited with spaces.

token_type string

Possible values: [bearer]

{
  "access_token": "string",
  "expires_in": 0,
  "scope": "string",
  "token_type": "bearer"
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64
• errors object[]

  httpcode integer

  message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Forbidden

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64
• errors object[]

  httpcode integer

  message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}