Skip to main content

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 NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringoperationID is used for global link tracking
tokeneyJhbxxxx3XsRequiredstringAdministrator token

Request Sample Parameters

{
"platformID": 2,
"userID": "4950983283"
}
Field NameOptionalTypeDescription
platformIDintstringPlatform ID: 1: IOS, 2: Android, 3: Windows, 4: OSX, 5: Web, 6: MiniWeb, 7: Linux, 8: Android Pad, 9: IPad, 10: admin
userIDRequiredstringUser ID

Successful Return Sample

{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}

Successful Return Sample Explanation

Parameter NameTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty when no error
errDlterrDltDetailed error message, empty when no error
dataobjectGeneral data object, the specific structure is shown below

Failed Return Sample

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

Failed Return Sample Explanation

Parameter NameTypeDescription
errCodeintError code, refer to the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message