24 Sign Out

Sign Out

Log out of the system and close the session.

API

POST /api/v1/sign/out

Request parameters:

Field	Type	Description
session	STRING	Required. Session code.
close_all	BOOLEAN	Optional. Close all active sessions for the current user. Default: false.

Behavior:

• When close_all is false (default), only the session specified in the session parameter is closed.
• When close_all is true, all active sessions for the user associated with the given session are closed.

Example:

Request:

POST /api/v1/sign/out HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.[abbreviated]...

{"session": "149d2ae6fa3f82eda21f7dba21824f199d508343"}

Close all sessions:

POST /api/v1/sign/out HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.[abbreviated]...

{"session": "149d2ae6fa3f82eda21f7dba21824f199d508343", "close_all": true}

See Also

• Sign In -- logging in to the system
• Authorization (OAuth 2.0) -- token-based authorization