Box Session Termination API

openapi: 3.2.0
info:
  title: Box Platform Session termination API
  description: Box Platform provides functionality to provide access to content stored within Box. It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.
  termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
  contact:
    name: Box, Inc
    url: https://developer.box.com
    email: devrel@box.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '2024.0'
  x-box-commit-hash: 53bdced3cd
servers:
- url: https://api.box.com/2.0
  description: Box Platform API server.
security:
- OAuth2Security: []
tags:
- name: Session termination
  description: Session termination API is used to validate the roles and permissions of the group, and creates asynchronous jobs to terminate the group's sessions.
  x-box-tag: session_termination
paths:
  /users/terminate_sessions:
    post:
      operationId: post_users_terminate_sessions
      summary: Create jobs to terminate users session
      description: 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.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                user_ids:
                  description: A list of user IDs.
                  type: array
                  items:
                    type: string
                  example:
                  - '123456'
                  - '456789'
                user_logins:
                  description: A list of user logins.
                  type: array
                  items:
                    type: string
                  example:
                  - user@sample.com
                  - user2@sample.com
              required:
              - user_ids
              - user_logins
      responses:
        '202':
          description: Returns a message about the request status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionTerminationMessage'
        '400':
          description: '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.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '403':
          description: Returns an error if there are insufficient permissions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '404':
          description: Returns an error if the resource could not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '429':
          description: Returns an error if the rate limit is exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '500':
          description: Returns an error if there is an internal server issue.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '503':
          description: Returns an error if the request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: session_termination
      tags:
      - Session termination
      x-codeSamples:
      - lang: curl
        label: Create jobs to terminate users session
        source: "curl -i -X POST \"https://api.box.com/2.0/users/terminate_sessions\" \\\n    -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n    -H \"content-type: application/json\" \\\n    -H \"accept: application/json\" \\\n    -d\n  {\n      user_ids: [\"6178859178\", \"4824866571\"]\n      user_logins: [\"user@example.com\", \"user2@example.com\",]\n  }"
      - lang: dotnet
        label: Create jobs to terminate users session
        source: 'await client.SessionTermination.TerminateUsersSessionsAsync(requestBody: new TerminateUsersSessionsRequestBody(userIds: Array.AsReadOnly(new [] {Utils.GetEnvVar("USER_ID")}), userLogins: Array.AsReadOnly(new [] {NullableUtils.Unwrap(user.Login)})));'
      - lang: swift
        label: Create jobs to terminate users session
        source: 'try await client.sessionTermination.terminateUsersSessions(requestBody: TerminateUsersSessionsRequestBody(userIds: [Utils.getEnvironmentVariable(name: "USER_ID")], userLogins: [user.login!]))'
      - lang: java
        label: Create jobs to terminate users session
        source: client.getSessionTermination().terminateUsersSessions(new TerminateUsersSessionsRequestBody(Arrays.asList(getEnvVar("USER_ID")), Arrays.asList(user.getLogin())))
      - lang: node
        label: Create jobs to terminate users session
        source: "await client.sessionTermination.terminateUsersSessions({\n  userIds: [getEnvVar('USER_ID')],\n  userLogins: [user.login!],\n} satisfies TerminateUsersSessionsRequestBody);"
      - lang: python
        label: Create jobs to terminate users session
        source: "client.session_termination.terminate_users_sessions(\n    [get_env_var(\"USER_ID\")], [user.login]\n)"
  /groups/terminate_sessions:
    post:
      operationId: post_groups_terminate_sessions
      summary: Create jobs to terminate user group session
      description: Validates the roles and permissions of the group, and creates asynchronous jobs to terminate the group's sessions. Returns the status for the POST request.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                group_ids:
                  description: A list of group IDs.
                  type: array
                  items:
                    type: string
                  example:
                  - '123456'
                  - '456789'
              required:
              - group_ids
      responses:
        '202':
          description: Returns a message about the request status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionTerminationMessage'
        '400':
          description: 'Returns an error if some of the parameters are not valid.


            - `Groups can not be NULL or EMPTY` when no value is provided.

            - `group id format is string` when the provided group id format is incorrect.

            - `Supported payload format is JSON` when the provided payload format is incorrect.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '403':
          description: Returns an error if there are insufficient permissions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '404':
          description: Returns an error if the resource could not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '429':
          description: Returns an error if the request limit is exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '500':
          description: Returns an error if there is an internal server issue.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '503':
          description: Returns an error if the request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: session_termination
      tags:
      - Session termination
      x-codeSamples:
      - lang: curl
        label: Create jobs to terminate user group session
        source: "curl -i -X POST \"https://api.box.com/2.0/groups/terminate_sessions\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -H \"accept: application/json\" \\\n     -d\n    {\n    \"group_ids\": [\"6178859178\", \"4824866571\"],\n    }"
      - lang: dotnet
        label: Create jobs to terminate user group session
        source: 'await client.SessionTermination.TerminateGroupsSessionsAsync(requestBody: new TerminateGroupsSessionsRequestBody(groupIds: Array.AsReadOnly(new [] {group.Id})));'
      - lang: swift
        label: Create jobs to terminate user group session
        source: 'try await client.sessionTermination.terminateGroupsSessions(requestBody: TerminateGroupsSessionsRequestBody(groupIds: [group.id]))'
      - lang: java
        label: Create jobs to terminate user group session
        source: client.getSessionTermination().terminateGroupsSessions(new TerminateGroupsSessionsRequestBody(Arrays.asList(group.getId())))
      - lang: node
        label: Create jobs to terminate user group session
        source: "await client.sessionTermination.terminateGroupsSessions({\n  groupIds: [group.id],\n} satisfies TerminateGroupsSessionsRequestBody);"
      - lang: python
        label: Create jobs to terminate user group session
        source: client.session_termination.terminate_groups_sessions([group.id])
components:
  schemas:
    ClientError:
      description: A generic error.
      type: object
      properties:
        type:
          description: The value will always be `error`.
          type: string
          example: error
          enum:
          - error
        status:
          description: The HTTP status of the response.
          type: integer
          format: int32
          example: 400
        code:
          description: A Box-specific error code.
          type: string
          example: item_name_invalid
          enum:
          - created
          - accepted
          - no_content
          - redirect
          - not_modified
          - bad_request
          - unauthorized
          - forbidden
          - not_found
          - method_not_allowed
          - conflict
          - precondition_failed
          - unprocessable_entity
          - too_many_requests
          - internal_server_error
          - unavailable
          - item_name_invalid
          - insufficient_scope
        message:
          description: A short message describing the error.
          type: string
          example: Method Not Allowed
        context_info:
          description: A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
          type:
          - object
          - 'null'
          example:
            message: Something went wrong
          additionalProperties: {}
        help_url:
          description: A URL that links to more information about why this error occurred.
          type: string
          example: https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
        request_id:
          description: A unique identifier for this response, which can be used when contacting Box support.
          type: string
          example: abcdef123456
      title: Client error
      x-box-resource-id: client_error
    SessionTerminationMessage:
      description: A message informing about the termination job status.
      type: object
      properties:
        message:
          description: The unique identifier for the termination job status.
          type: string
          example: 'Request is successful, please check the admin

            events for the status of the job'
      title: Session termination message
      x-box-resource-id: session_termination
      x-box-tag: session_termination
  securitySchemes:
    OAuth2Security:
      type: oauth2
      description: The access token received from the authorization server in the OAuth 2.0 flow.
      flows:
        authorizationCode:
          authorizationUrl: https://account.box.com/api/oauth2/authorize
          tokenUrl: https://api.box.com/oauth2/token
          scopes:
            root_readonly: Read all files and folders stored in Box
            root_readwrite: Read and write all files and folders stored in Box
            manage_app_users: Provision and manage app users
            manage_managed_users: Provision and manage managed users
            manage_groups: Manage an enterprise's groups
            manage_webhook: Create webhooks programmatically through the API
            manage_enterprise_properties: Manage enterprise properties
            manage_data_retention: Manage data retention polices
            manage_legal_hold: Manage Legal Holds
externalDocs:
  description: Box Developer Documentation.
  url: https://developer.box.com
x-mint:
  mcp:
    enabled: true
x-provenance:
  method: harvested
  publisher: Box
  source: https://developer.box.com/box-openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)