Sign in authentication

POST

/auth/sign_in

Last modified:2025-09-01 18:52:30

This endpoint allows users to authenticate using their username and password.
Depending on whether the user has Two-Factor Authentication (2FA) enabled,
the authentication flow will vary:

Without 2FA: Provide the username and password in the request. Upon successful authentication,
the endpoint will return an authentication token to be used in subsequent requests.

With 2FA:

First, provide the username and password in the request.

The endpoint will not return a token immediately.
Instead, it will return an otp_session_state, which represents the current 2FA session.

Next, use the same endpoint (/auth/sign_in) with the following parameters: otp_attempt
and otp_session_state.

Upon successful 2FA verification, the endpoint will return the authentication token.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

Successful Sign In

Body

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/auth/sign_in' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "alice",
    "password": "secret123"
}'

Response Example

200 - Example 1

{
    "status": 200,
    "status_text": "OK",
    "username": "john_doe",
    "token": "string",
    "sign_in_count": 10,
    "role": "User",
    "timezone": "UTC",
    "verified": true,
    "provider": "email",
    "organization": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "Example Organization"
    }
}

Modified at 2025-09-01 18:52:30

Send SMS OTP