Attempts to authenticate the provided user id and password
| Header | Name | Description | Type | Additional information |
|---|---|---|---|---|
| Accept | Mime Type |
The accept header used to specify the acceptable response mime type |
string |
Optional |
None.
The login request containing the user name and password to authenticate
{
"UserId": "sample string 1",
"Password": "sample string 2",
"AppKey": "4df17bad-2017-4c6b-bfa8-114dede0b4c2",
"SecondaryId": "sample string 4"
}
A user authentication response containing the results of the authentication request
{
"IsAuthenticated": true,
"SecurityToken": "c52ba9ee-eac9-4602-ad79-cc6a4bf89f8b",
"UserId": "sample string 1",
"Status": 0,
"SecondaryId": "sample string 1",
"Role": 0,
"CorpId": null
}
An error response containing the details about a failed api request
{
"error": {
"batcherror": {
"operationindex": 1,
"requestindex": 2
},
"code": "UnknownError",
"innererror": {
"innererror": {
"message": {
"lang": "en-US",
"value": "sample string 3"
},
"type": "sample string 5",
"trace": "sample string 4"
},
"message": {
"lang": "en-US",
"value": "sample string 6"
},
"type": "sample string 8",
"trace": "sample string 7"
},
"message": {
"lang": "en-US",
"value": "sample string 9"
}
}
}