Force user logout
Brief Description
- Force a specific user to log out from a certain terminal.
Request Method
post
Request URL
http://x.x.x.x:10002/auth/force_logout
Header
Header Name | Example Value | Optional | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | operationID is used for global link tracking |
token | eyJhbxxxx3Xs | Required | string | Administrator token |
Request Sample Parameters
{
"platformID": 2,
"userID": "4950983283"
}
Field Name | Optional | Type | Description |
---|---|---|---|
platformID | int | string | Platform ID: 1: IOS, 2: Android, 3: Windows, 4: OSX, 5: Web, 6: MiniWeb, 7: Linux, 8: Android Pad, 9: IPad, 10: admin |
userID | Required | string | User ID |
Successful Return Sample
{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}
Successful Return Sample Explanation
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, 0 indicates success |
errMsg | string | Brief error message, empty when no error |
errDlt | errDlt | Detailed error message, empty when no error |
data | object | General data object, the specific structure is shown below |
Failed Return Sample
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Failed Return Sample Explanation
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, refer to the global error code document |
errMsg | string | Brief error message |
errDlt | errDlt | Detailed error message |