Logout Current User Session

Prev Next
Post
/api/v1/sessions/logout.me
Premium tag

This endpoint allows an authenticated user to log out of any of their sessions on the workspace. It is designed specifically for the user to terminate their sessions and cannot be used to log out sessions belonging to other users on the workspace.

Changelog

Version Description
5.0.0 Added
Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Body parameters
Example
{
  "sessionId": "WJ2giBwm4B9mcojFi"
}
object
sessionId
string Required

The session ID.

Responses
200

OK

Success Example
{
  "sessionId": "WJ2giBwm4B9mcojFi",
  "success": true
}
object
sessionId
string
success
boolean
400

Bad Request

Session not found
{
  "success": false,
  "error": "Session not found"
}
object
success
boolean
error
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
Tags