Skip to main content
POST
Authenticate user

Headers

User-Agent
string
X-Forwarded-For
string
Example:

"127.0.0.1"

X-Tenant-ID
string
Example:

"tenant-demo-001"

sec-ch-ua-platform
string
X-Forwarded-From
string

Client source identifier

Example:

"client-app"

platform
string

Client platform

Example:

"mobile"

deviceId
string

Device identifier

Example:

"device-demo-001"

Body

application/json
email
string

Login email

Example:

"admin@example.test"

password
string

Login password

Example:

"SecurePass123!"

tenantId
string

Tenant identifier

Example:

"tenant-demo-001"

captchaToken
string

Optional captcha token

Example:

"captcha-token-sample"

Response

200 - application/json

OK

Standard API response wrapper

code
integer<int32>

HTTP-style status code

Example:

200

data
object

Response payload object

Example:
message
string

Result message

Example:

"Success"