Create an access token

POST 
/api/auth/token

Exchanges a partner's clientId, clientSecret, and partnerId for a short-lived JWT access token. The returned token must be sent as a Bearer token in the Authorization header of subsequent requests.

Request

application/json

Body

required

clientId stringrequired
clientSecret stringrequired
partnerId stringrequired
scope stringrequired

Possible values: Value must match regular expression admin|user

Responses

200

Token issued successfully

application/json

Schema

Schema

access_token string
token_type string
expires_in int32
partner_id string
scope string

Example (from schema)

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

401

Invalid partnerId, clientId, or clientSecret

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

500

JWT authentication is not available

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

Loading...