Logout Session

This endpoint allows an authenticated user{ "success": false, "error": "User does not have the permissions required for this action [error-unauthorized]" }{ "success": false, "error": "User does not have the permissions required for this action [error-unauthorized]" } to log out any user's session on the workspace. It provides the capability to terminate sessions of other users, ensuring workspace security and management.
It requires thelogout-device-management permission.
It requires two-factor authentication.​
URL
Requires Auth
HTTP Method
/api/v1/sessions/logout
yes
POST
Headers
Argument
Example
Required
Description
X-User-Id
myuser-name
Required
The authenticated user ID.
X-Auth-Token
myauth-token
Required
Auth token.
x-2fa-code
148750
Required
The 2fa code.
Payload
Argument
Example
Required
Description
sessionId
WJ2giBwm4B9mcojFi
Required
The session id.
Example Payload
{
    "sessionId":"tTouumJMrHMjnedWf"
}
Example Call
curl --location 'http://localhost:3000/api/v1/sessions/logout' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: ocFlTSMfowj9tSH1vQV6ANL9SiahkKUK1KhU_PpAUtT' \
--header 'X-User-Id: 2tTEqR7ZNMJ4HGGNa' \
--header 'x-2fa-code: 505403' \
--data '{
    "sessionId":"tTouumJMrHMjnedWf"
}'
Example Result
Success
{
    "sessionId": "tTouumJMrHMjnedWf",
    "success": true
}
Error
Any of the following errors can occur on the endpoint.
Authorization: Requires an authentication token for the request to be made.
No Permission: Occurs when the authenticated user doesn't have the logout-device-management permission.
TOTP Required: Requires two-factor authentication for the request to be made.
Invalid TOTP: Requires a valid two-factor authentication code.
Session not found: Occurs when the sessionId does not exist.
Authorization
No Permission
Session not found
TOTP Required
Invalid TOTP
{
    "status": "error",
    "message": "You must be logged in to do this."
}
{
    "success": false,
    "error": "User does not have the permissions required for this action [error-unauthorized]"
}
{
    "success": false,
    "error": "Session not found"
}
{
    "success": false,
    "error": "TOTP Required [totp-required]",
    "errorType": "totp-required",
    "details": {
        "method": "totp",
        "codeGenerated": false,
        "availableMethods": [
            "totp"
        ]
    }
}
{
    "success": false,
    "error": "TOTP Invalid [totp-invalid]",
    "errorType": "totp-invalid",
    "details": {
        "method": "totp",
        "codeGenerated": false
    }
}
Change Log
Version
Description
5.0.0
Added

URL	Requires Auth	HTTP Method
`/api/v1/sessions/logout`	`yes`	`POST`

Argument	Example	Required	Description
`X-User-Id`	`myuser-name`	Required	The authenticated user ID.
`X-Auth-Token`	`myauth-token`	Required	Auth token.
`x-2fa-code`	`148750`	Required	The 2fa code.

Argument	Example	Required	Description
`sessionId`	`WJ2giBwm4B9mcojFi`	Required	The session id.

Version	Description
5.0.0	Added

Last modified 2mo ago