Sign in

v1

latestOpenAPI 3.0.12026-07-227292131.4 KB
me

Create an auth token.

Create a short-term authentication token using user credentials for exchanging access and refresh tokens.

post/me/auth-tokens

Request body

emailstring required

User's email address.

  • Must be a valid email format.
passwordstring required

User's password.

Example request

{
  "email": "john_doe@example.com",
  "password": "john_doe_password"
}

Response

Successfully created an auth token for user.

authTokenstring required

A temporary token issued after the initial login step. This token is used in the create session API to exchange for access and refresh tokens.

is2FARequiredboolean required

Whether two-factor authentication (2FA) is required for the create session API. If true, the client must include an OTP code in the request body to complete the authentication.

Example response

{
  "authToken": "eyJhbGciOiJIUzI1NiIsInR...",
  "is2FARequired": true
}