Links
Comment on page

Logout Other Clients

Logs out other clients.
URL
Requires Auth
HTTP Method
api/v1/users.logoutOtherClients
YES
POST

Headers

Argument
Example
Required
Description
X-User-Id
myuser-name
Required
Your username hash (returned after you log in through the API)
X-Auth-Token
myauth-token
Required
Your token (returned after you log in through the API)

Example Call

curl --location --request POST http://localhost:3000/api/v1/users.logoutOtherClients\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'

Result

Success

{
"token": "SnS70r0VkngGFrSbxVK-pdwFMEzhefcjQgdnXaPeAaq",
"tokenExpires": "2021-12-27T14:33:09.851Z",
"success": true
}

Errors

The following error can occur upon the endpoint.
  • Authorization: Requires an authentication token for the request to be made.
Authorization
{
"status": "error",
"message": "You must be logged in to do this."
}
Last modified 1yr ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.