force_logout

Brief Description

• Force a user to log out from a specific terminal. The client SDK will receive the onKickedOffline callback event.

Request Method

• POST

Request URL

• {API_ADDRESS}/auth/force_logout

Header

Header Name	Example Value	Required	Type	Description
operationID	1646445464564	Required	string	Used for global traceability. It is recommended to use a timestamp, with a unique value for each request.
token	eyJhbxxxx3Xs	Required	string	Admin token

Request Parameter Example

{
  "platformID": 2,
  "userID": "4950983283"
}

Field Name	Required	Type	Description
platformID	Required	int	User login terminal type, with values ranging from 1-9.
userID	Required	string	User ID

Success Response Example

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

Success Response Parameter Description

Parameter Name	Type	Description
errCode	int	Error code, 0 indicates success
errMsg	string	Brief error message, empty if successful
errDlt	string	Detailed error message, empty if successful

Failure Response Example

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

Failure Response Parameter Description

Parameter Name	Type	Description
errCode	int	Error code, see the global error code document for details
errMsg	string	Brief error message
errDlt	string	Detailed error message