Join BoxWorks 2024 to discover what's possible with content and AI!

Create jobs to terminate users session

post

https://api.box.com/2.0

/users/terminate_sessions

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.

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Request Body

user_ids string arrayin bodyrequired

example["123456","456789"]

A list of user IDs

user_logins string arrayin bodyrequired

example["user@sample.com","user2@sample.com"]

A list of user logins

Response

202application/jsonSession termination message

Returns a message about the request status.

400application/jsonClient error

Returns an error if some of the parameters are not valid.

Users can not be NULL or EMPTY when no value is provided
User id format is string when the provided user id format is incorrect
Supported payload format is JSON when the provided payload format is incorrect

403application/jsonClient error

Returns an error if there are insufficient permissions.

404application/jsonClient error

Returns an error if the resource could not be found.

429application/jsonClient error

Returns an error if the rate limit is exceeded.

500application/jsonClient error

Returns an error if there is an internal server issue.

503application/jsonClient error

Returns an error if the request timed out.

defaultapplication/jsonClient error

An unexpected client error.

post

Create jobs to terminate users session

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -i -X POST "https://api.box.com/2.0/users/terminate_sessions" \
    -H "authorization: Bearer <ACCESS_TOKEN>" \
    -H "content-type: application/json" \
    -H "accept: application/json" \
    -d
  {
      user_ids: ["6178859178", "4824866571"]
      user_logins: ["user@example.com", "user2@example.com",]
  }

TypeScript Gen

await client.sessionTermination.terminateUsersSessions({
  userIds: [getEnvVar('USER_ID')],
  userLogins: [user.login!],
} satisfies TerminateUsersSessionsRequestBody);

Python Gen

client.session_termination.terminate_users_sessions(
    [get_env_var("USER_ID")], [user.login]
)

.NET Gen

await client.SessionTermination.TerminateUsersSessionsAsync(requestBody: new TerminateUsersSessionsRequestBody(userIds: Array.AsReadOnly(new [] {Utils.GetEnvVar("USER_ID")}), userLogins: Array.AsReadOnly(new [] {NullableUtils.Unwrap(user.Login)})));

Swift Gen (Beta)

try await client.sessionTermination.terminateUsersSessions(requestBody: TerminateUsersSessionsRequestBody(userIds: [Utils.getEnvironmentVariable(name: "USER_ID")], userLogins: [user.login!]))

Node

var userIDs = ['33333', '44444'];
var userLogins = ['user1@example.com', 'user2@example.com'];

client.users.terminateSession({
    user_ids: userIDs,
    user_logins: userLogins
}).then((result) => {
        /* result -> {
            message: "Request is successful, please check the admin events for the status of the job" }
        */
    });

Response Example

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