BObox
Session termination

Create jobs to terminate users session

Changed on

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

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/users/terminate_sessions
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

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"
}

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status