Authentication

POST /authenticate

This API endpoint allows users to authenticate and receive an ID token, access token, and refresh token.

Headers

Name
Value

Content-Type

application/json

Body

Name
Type
Description

username

string

The user's email address

password

string

The user's password

totp

string

Two-factor authentication code

Note: The TOTP code is not required during the initial login. If this is the user’s first login, the system will return a setup code that must be used to generate a QR code. This QR code should be scanned using an authenticator application (e.g., Google Authenticator) to configure two-factor authentication (2FA).

To complete the authentication process and receive the authorization token, a valid TOTP code generated by the authenticator application must then be provided.

Response

{
    "statusCode": 200,
    "statusMessage": "Request successful",
    "payload": {
        "idToken": "eyJraWQiOiJLT0R...",
        "accessToken": "eyJraWQiOiJLT0R...",
        "refreshToken": "eyJraWQiOiJLT0R...",
        "traceId": "gdlyfx1kn79mm0e66an",
    }
}

Last updated