POST /auth/login
Authenticate user with username and password
/auth/login
POST
Authenticate user with username and password
| Key | Type | Example | Description |
|---|---|---|---|
| entity optional | string |
"example-string"
|
Entity identifier (optional)
|
| username required | string |
"example-string"
|
|
| password required | string |
"••••••••"
|
|
| request_refresh_token optional | boolean |
true
|
{
"access_token": "example-string",
"expiry": 42,
"expiry_renew": 42,
"verified": true,
"2fa": [
"example-string"
],
"default_2fa": "example-string",
"user": {},
"device": {},
"ip": "example-string",
"refresh_token": "example-string",
"refresh_token_expiry": 42
}
{
"error": "INVALID_ACCESS_TOKEN",
"code": 401
}
| Status | Error Code | Description |
|---|---|---|
401 |
INVALID_ACCESS_TOKEN |
Authentication required or invalid token |
403 |
INSUFFICIENT_PERMISSIONS |
Insufficient permissions for this operation |
429 |
TOO_MANY_LOGIN_ATTEMPTS |
Too many requests - rate limit exceeded |
| Permission | Description |
|---|---|
*public |
No authentication required — public endpoint |
Back to Authentication Return to the Authentication category to view other endpoints All API Categories Browse all available API categories