POST /auth/login
Authenticate user with username and password
/auth/login
POST
Authenticate user with username and password
| Key | Type | Example | Description |
|---|---|---|---|
| username required | string |
"john@example.com"
|
Username or email
|
| password required | string |
"secretpassword"
|
User password
|
{
"access_token": "example-string",
"refresh_token": "example-string",
"user": {
"_meta": {
"guid": "example-string",
"entity": "example-value",
"created": "example-value",
"modified": "example-value",
"updated": "example-value"
},
"username": "example-string",
"email": "example-string",
"firstname": "example-string",
"lastname": "example-string",
"last_activity": "example-value",
"timezone": "example-string",
"language": "example-string"
},
"expires_at": "example-value",
"scopes": [
"example-string"
]
}
{
"success": false,
"error": "HTTP_401",
"message": "Error response"
}
| Error Code | Description |
|---|---|
| HTTP_401 | HTTP 401 error |
| HTTP_403 | HTTP 403 error |
| HTTP_429 | HTTP 429 error |
| 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