These docs are for v2.11. Click to read the latest docs for v2.12.

Create Auth Token

Create an authentication token to use for API requests.

Notes

A successful call to this endpoint will return an HTTP status code of 201 Created and an Authorization object in a JSON response.

An unsuccessful call (due to an incorrect user name or password) will return an HHTP status code of 401 Unauthorized.

Example Response

{
  "auth": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50Ijp7ImlkIjoiODAwODA1NjU2MiJ9LCJwb3J0YWwiOnsidG9rZW4iOiJjODJjMmVkYzMzNWIwYzI3NjYwOWIzNDcxMmFmOWZlOCJ9LCJpYXQiOjE1MTYxMzc1NTQsImV4cCI6MTUxNjE0MTE1NH0.9XdG1o-KIsO_K7o0eaHb-Enqy4ETkQSQS4MhpdvhsrE"
  }
}

Once you have a token, you can use it to authenticate your requests by including it in a Token header:

...
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50Ijp7ImlkIjoiODAwODA1NjU2MiJ9LCJwb3J0YWwiOnsidG9rZW4iOiJjODJjMmVkYzMzNWIwYzI3NjYwOWIzNDcxMmFmOWZlOCJ9LCJpYXQiOjE1MTYxMzc1NTQsImV4cCI6MTUxNjE0MTE1NH0.9XdG1o-KIsO_K7o0eaHb-Enqy4ETkQSQS4MhpdvhsrE
...

Response Properties

PropertyTypeDescription
authorizationobjectAuthorization object.
Language
Click Try It! to start a request and see the response here!