v1

latestOpenAPI 3.0.12026-07-227292131.4 KB
me

Create session

Create a login session for user.

post/me/sessions

Headers

CE-ClientIdstring required

A unique identifier to each user device and browser.

  • Must be less than 8 characters.
  • Only alphanumeric characters are allowed.

Request body

authTokenstring required

A temporary token issued by the create auth token API. This token is used in the create session API to exchange for access and refresh tokens.

otpCodestring

(Optional) A one-time passcode (OTP) provided by the user for native login with 2FA verification.

  • Must be a numeric code.
  • This field is required only if the is2FARequired field in the POST /me/auth-tokens API response is true.

Example request

{
  "authToken": "eyJhbGciOiJIUzI1NiIsInR..."
}

Response

Successfully created a login session for user.

accessTokenstring required

The access token for API requests.

refreshTokenstring required

The refresh token for session management.

Example response

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR..."
}