Logout Session

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

This endpoint allows an authorized user to log out other user's session on the workspace and requires 2FA. It provides the capability to terminate sessions of other users, ensuring workspace security and management.

Permission required: logout-device-management

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
X-2fa-Code
stringRequired

The 2FA code from the authentication method. If the method is password, encrypt it as SHA256.

X-2fa-method
stringRequired

The desired method to get the 2FA code. It can be email, totp, or password.

Body parameters
object
sessionId
string Required

The session ID.

Responses
200

OK

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

Bad Request

TOTP Error
{
  "success": false,
  "error": "TOTP Required [totp-required]",
  "errorType": "totp-required",
  "details": {
    "method": "password",
    "codeGenerated": false,
    "availableMethods": []
  }
}
Expand All
object
success
boolean
error
string
errorType
string
details
object
method
string
codeGenerated
boolean
availableMethods
Array of object
object
401

Unauthorized

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

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
object
success
boolean
error
string
Tags