Login

POST 
/v1/auth/login-verification

Login

This endpoint verifies user login credentials and handles two-factor authentication (2FA). It accepts optional query parameters for specifying an email template and locale. Upon successful validation, it sends a confirmation code via email using the selected template. Responses include success confirmation, forbidden access due to 2FA requirements, or invalid credentials error.

Request

Query Parameters

template string

The email template to use

locale string

The locale to use

application/json

Body

required

email stringrequired
isForAdmin booleannullable
passwordHash stringrequired

Responses

200

Confirmation code sent to email

application/json

Schema

Schema

string

401

Invalid credentials

application/json

Schema

Schema

string

403

Forbidden

application/json

Schema

Schema

createdAt date-timerequired
id uuidrequired
name stringnullable
twoFaTypeId int32required
verified booleannullable

Example (from schema)

{
  "createdAt": "2024-09-25T19:42:12.374Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "twoFaTypeId": 0,
  "verified": true
}

Loading...