Authenticating

REST API uses token-based authentication.

A security token with the property that any party in possession of the token (a "bearer") can use the token in any way that any other party in possession of it can. Using a bearer token does not require a bearer to prove possession of cryptographic key material (proof-of-possession).

Authentication is done in two steps. First, you make an authentication request using your credentials. The response to this request is a token. Second, you use this token to make all other requests.

• Make an auth request. The response will include a token in the token field.

• Include the obtained token into request headers. Use the Authorization header to do so. Its value must start with the "Bearer" string, followed by the obtained token.

Example: Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiAZJhZG1pbiIsImV4cCI6MTU1NjE4MTI3NywiaWF0IjoxNTU2MTc3Njc3fQ.LkG0WmgiRn3O1vREbRzDCigCSMeGbI337fsioTgK1p-kMIYx1R4d_lcUOQYN3gpFBazvvmR3mO2j4fb5J3YFug

Tokens expire after the period defined in the Token Expiration Period parameter. A valid token can be used to generate a new one using the refresh request. Supply the current token. Response will contain a new token.

Was this page helpful?

Tell us more

Send

Thank you!