Users

Log in

Changed on

Authenticate and return a JWT token bundle.

post/auth/login

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /auth/login
  • Auth: none required

Request body

emailstring required

Email address of the user.

passwordstring required

The user's password.

Example request

{
  "email": "ada@example.com",
  "password": "example-password"
}

Response

Successful Response

access_tokenstring required

Signed JWT to send as a bearer token on subsequent requests.

expires_ininteger required

Lifetime of the access token in seconds.

must_change_passwordboolean required

Whether the user must change their password before using other endpoints.

token_typestring required

Token type; always bearer.

Example response

{
  "access_token": "example-access-token",
  "expires_in": 3600,
  "must_change_password": false,
  "token_type": "bearer"
}

Changes