HomeGuidesAPI Reference
API Reference

Terminate active user sessions

Forcefully terminates specified user sessions on the Orchestrator. Sessions are matched using the combination of 'username' and 'login_time' (UNIX timestamp in seconds as string). Each successful termination is logged as a system action. Requires READ_WRITE role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Array of session identifiers to terminate. Each object must contain 'username' and 'login_time' fields for session matching.

Array of session identifiers for termination. Sessions are matched by username and login_time combination.

Identifies a specific session for termination using username and login timestamp.

string
required

The login identifier of the user whose session to terminate.

string
required
^[0-9]+$

UNIX timestamp (seconds since epoch) as a string when the session was created. Used with username to uniquely identify the session.

Responses
200

Sessions terminated successfully. No content returned. A system action log entry is created for each deleted session.

401

Unauthorized. User session is invalid or expired.

403

Forbidden. Requires READ_WRITE role to terminate sessions.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json