Sign in

v1

latestOpenAPI 3.0.12026-07-1714724311.1 KB
Authentication

Retrieve a Temporary Access Token

Retrieve a Temporary Access Token

post/auth/login

Request body

emailstring required

Email address of the user you're retrieving the access token for.

passwordstring password required

Password of the user.

mode'json' | 'cookie' | 'session'

Whether to retrieve the refresh token in the JSON response, or in a httpOnly cookie.

otpstring

The user's one-time-password (if MFA is enabled).

Example request

{
  "email": "admin@example.com",
  "password": "password"
}

Response

Successful authentification

Example response

{
  "data": {
    "access_token": "eyJhbGciOiJI...",
    "expires": 900,
    "refresh_token": "yuOJkjdPXMd..."
  }
}