Check the username/password of a user
POST/api/account/login
Example Request
{
"username": "[email protected]",
"password": "",
"persistent": false,
"rememberUserName": true,
"tenant": "my-tenant",
"clientId": "my-app-id"
}Parameters
| Name | Description |
|---|---|
string (body) | |
string (body) | |
boolean (body) | |
boolean (body) | |
string (body) | |
string (body) | |
string (body) | |
(body) | |
boolean (body) |
Responses
200
If the request was successful. May not indicate the user was signed in completely
{
"sessionToken": null,
"stateToken": null,
"next": "done",
"principal": ,
"items": null
}| Name | Type | Description | Format |
|---|---|---|---|
| sessionToken | string | ||
| stateToken | string | ||
| next | string | ||
| principal | |||
| items | object |
400
If the username or password was incorrect. Or some other user-facing error occurred
{
"type": null,
"identifier": "",
"message": null,
"responseCode": null,
"errors": null
}| Name | Type | Description | Format |
|---|---|---|---|
| type | string | ||
| identifier | string | uuid | |
| message | string | ||
| responseCode | string | ||
| errors | array |
401
If the user is not allowed to sign in currently
403
Forbidden
{
"type": null,
"identifier": "",
"message": null,
"responseCode": null,
"errors": null
}| Name | Type | Description | Format |
|---|---|---|---|
| type | string | ||
| identifier | string | uuid | |
| message | string | ||
| responseCode | string | ||
| errors | array |