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": "559a8438-0bf5-4e70-94b3-7a66c152df60",
"SecondaryId": "sample string 4"
}
A user authentication response containing the results of the authentication request
{
"IsAuthenticated": true,
"SecurityToken": "89e66778-0d19-440b-8601-2313f9196253",
"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"
}
}
}