v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB
Session termination

Create jobs to terminate users session

Validates the roles and permissions of the user, and creates asynchronous jobs to terminate the user's sessions. Returns the status for the POST request.

post/users/terminate_sessions

Request body

user_idsstring[] required

A list of user IDs.

user_loginsstring[] required

A list of user logins.

Example request

{
  "user_ids": [
    "123456",
    "456789"
  ],
  "user_logins": [
    "user@sample.com",
    "user2@sample.com"
  ]
}

Response

Returns a message about the request status.

messagestring

The unique identifier for the termination job status.

Example response

{
  "message": "Request is successful, please check the admin\nevents for the status of the job"
}