Box Domain Restrictions (User Exemptions) API

openapi: 3.2.0
info:
  title: Box Platform Domain restrictions (User exemptions) 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: Domain restrictions (User exemptions)
  description: A set of endpoints that allow exempting users from restrictions imposed by the list of allowed collaboration domains for a specific enterprise.
  x-box-tag: collaboration_allowlist_exempt_targets
paths:
  /collaboration_whitelist_exempt_targets:
    get:
      operationId: get_collaboration_whitelist_exempt_targets
      summary: List users exempt from collaboration domain restrictions
      description: Returns a list of users who have been exempt from the collaboration domain restrictions.
      parameters:
      - name: marker
        in: query
        description: 'Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.


          This requires `usemarker` to be set to `true`.'
        required: false
        schema:
          type: string
        example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
      - name: limit
        in: query
        description: The maximum number of items to return per page.
        required: false
        schema:
          type: integer
          format: int64
          maximum: 1000
        example: 1000
      responses:
        '200':
          description: Returns a collection of user exemptions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollaborationAllowlistExemptTargets'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: collaboration_allowlist_exempt_targets
      tags:
      - Domain restrictions (User exemptions)
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: List users exempt from collaboration domain restrictions
        source: "curl -i -X GET \"https://api.box.com/2.0/collaboration_whitelist_exempt_targets\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: List users exempt from collaboration domain restrictions
        source: await client.CollaborationAllowlistExemptTargets.GetCollaborationWhitelistExemptTargetsAsync();
      - lang: swift
        label: List users exempt from collaboration domain restrictions
        source: try await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTargets()
      - lang: java
        label: List users exempt from collaboration domain restrictions
        source: client.getCollaborationAllowlistExemptTargets().getCollaborationWhitelistExemptTargets()
      - lang: node
        label: List users exempt from collaboration domain restrictions
        source: await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTargets();
      - lang: python
        label: List users exempt from collaboration domain restrictions
        source: client.collaboration_allowlist_exempt_targets.get_collaboration_whitelist_exempt_targets()
    post:
      operationId: post_collaboration_whitelist_exempt_targets
      summary: Create user exemption from collaboration domain restrictions
      description: Exempts a user from the restrictions set out by the allowed list of domains for collaborations.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                user:
                  description: The user to exempt.
                  type: object
                  properties:
                    id:
                      description: The ID of the user to exempt.
                      type: string
                      example: '23522323'
                  required:
                  - id
              required:
              - user
      responses:
        '200':
          description: Returns a new exemption entry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollaborationAllowlistExemptTarget'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: collaboration_allowlist_exempt_targets
      tags:
      - Domain restrictions (User exemptions)
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Create user exemption from collaboration domain restrictions
        source: "curl -i -X POST \"https://api.box.com/2.0/collaboration_whitelist_exempt_targets\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"user\": {\n         \"id\": \"23522323\"\n       }\n     }'"
      - lang: dotnet
        label: Create user exemption from collaboration domain restrictions
        source: 'await client.CollaborationAllowlistExemptTargets.CreateCollaborationWhitelistExemptTargetAsync(requestBody: new CreateCollaborationWhitelistExemptTargetRequestBody(user: new CreateCollaborationWhitelistExemptTargetRequestBodyUserField(id: user.Id)));'
      - lang: swift
        label: Create user exemption from collaboration domain restrictions
        source: 'try await client.collaborationAllowlistExemptTargets.createCollaborationWhitelistExemptTarget(requestBody: CreateCollaborationWhitelistExemptTargetRequestBody(user: CreateCollaborationWhitelistExemptTargetRequestBodyUserField(id: user.id)))'
      - lang: java
        label: Create user exemption from collaboration domain restrictions
        source: client.getCollaborationAllowlistExemptTargets().createCollaborationWhitelistExemptTarget(new CreateCollaborationWhitelistExemptTargetRequestBody(new CreateCollaborationWhitelistExemptTargetRequestBodyUserField(user.getId())))
      - lang: node
        label: Create user exemption from collaboration domain restrictions
        source: "await client.collaborationAllowlistExemptTargets.createCollaborationWhitelistExemptTarget(\n  {\n    user: {\n      id: user.id,\n    } satisfies CreateCollaborationWhitelistExemptTargetRequestBodyUserField,\n  } satisfies CreateCollaborationWhitelistExemptTargetRequestBody,\n);"
      - lang: python
        label: Create user exemption from collaboration domain restrictions
        source: "client.collaboration_allowlist_exempt_targets.create_collaboration_whitelist_exempt_target(\n    CreateCollaborationWhitelistExemptTargetUser(id=user.id)\n)"
  /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}:
    get:
      operationId: get_collaboration_whitelist_exempt_targets_id
      summary: Get user exempt from collaboration domain restrictions
      description: Returns a users who has been exempt from the collaboration domain restrictions.
      parameters:
      - name: collaboration_whitelist_exempt_target_id
        in: path
        description: The ID of the exemption to the list.
        required: true
        schema:
          type: string
        example: '984923'
      responses:
        '200':
          description: Returns the user's exempted from the list of collaboration domains.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollaborationAllowlistExemptTarget'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: collaboration_allowlist_exempt_targets
      tags:
      - Domain restrictions (User exemptions)
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Get user exempt from collaboration domain restrictions
        source: "curl -i -X GET \"https://api.box.com/2.0/collaboration_whitelist_exempt_targets/984923\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Get user exempt from collaboration domain restrictions
        source: 'await client.CollaborationAllowlistExemptTargets.GetCollaborationWhitelistExemptTargetByIdAsync(collaborationWhitelistExemptTargetId: NullableUtils.Unwrap(newExemptTarget.Id));'
      - lang: swift
        label: Get user exempt from collaboration domain restrictions
        source: 'try await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTargetById(collaborationWhitelistExemptTargetId: newExemptTarget.id!)'
      - lang: java
        label: Get user exempt from collaboration domain restrictions
        source: client.getCollaborationAllowlistExemptTargets().getCollaborationWhitelistExemptTargetById(newExemptTarget.getId())
      - lang: node
        label: Get user exempt from collaboration domain restrictions
        source: "await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTargetById(\n  newExemptTarget.id!,\n);"
      - lang: python
        label: Get user exempt from collaboration domain restrictions
        source: "client.collaboration_allowlist_exempt_targets.get_collaboration_whitelist_exempt_target_by_id(\n    new_exempt_target.id\n)"
    delete:
      operationId: delete_collaboration_whitelist_exempt_targets_id
      summary: Remove user from list of users exempt from domain restrictions
      description: Removes a user's exemption from the restrictions set out by the allowed list of domains for collaborations.
      parameters:
      - name: collaboration_whitelist_exempt_target_id
        in: path
        description: The ID of the exemption to the list.
        required: true
        schema:
          type: string
        example: '984923'
      responses:
        '204':
          description: A blank response is returned if the exemption was successfully deleted.
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: collaboration_allowlist_exempt_targets
      tags:
      - Domain restrictions (User exemptions)
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Remove user from list of users exempt from domain restrictions
        source: "curl -i -X DELETE \"https://api.box.com/2.0/collaboration_whitelist_exempt_targets/984923\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Remove user from list of users exempt from domain restrictions
        source: 'await client.CollaborationAllowlistExemptTargets.DeleteCollaborationWhitelistExemptTargetByIdAsync(collaborationWhitelistExemptTargetId: NullableUtils.Unwrap(exemptTarget.Id));'
      - lang: swift
        label: Remove user from list of users exempt from domain restrictions
        source: 'try await client.collaborationAllowlistExemptTargets.deleteCollaborationWhitelistExemptTargetById(collaborationWhitelistExemptTargetId: exemptTarget.id!)'
      - lang: java
        label: Remove user from list of users exempt from domain restrictions
        source: client.getCollaborationAllowlistExemptTargets().deleteCollaborationWhitelistExemptTargetById(exemptTarget.getId())
      - lang: node
        label: Remove user from list of users exempt from domain restrictions
        source: "await client.collaborationAllowlistExemptTargets.deleteCollaborationWhitelistExemptTargetById(\n  exemptTarget.id!,\n);"
      - lang: python
        label: Remove user from list of users exempt from domain restrictions
        source: "client.collaboration_allowlist_exempt_targets.delete_collaboration_whitelist_exempt_target_by_id(\n    exempt_target.id\n)"
components:
  schemas:
    CollaborationAllowlistExemptTargets:
      description: A list of users exempt from any of the restrictions imposed by the list of allowed collaboration domains for this enterprise.
      type: object
      allOf:
      - type: object
        description: The part of an API response that describes marker based pagination.
        properties:
          limit:
            description: The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
            type: integer
            format: int64
            example: 1000
          next_marker:
            description: The marker for the start of the next page of results.
            type:
            - string
            - 'null'
            example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
          prev_marker:
            description: The marker for the start of the previous page of results.
            type:
            - string
            - 'null'
            example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih
      - properties:
          entries:
            description: A list of users exempt from any of the restrictions imposed by the list of allowed collaboration domains for this enterprise.
            type: array
            items:
              $ref: '#/components/schemas/CollaborationAllowlistExemptTarget'
      title: Allowed collaboration domains user exemptions
      x-box-resource-id: collaboration_allowlist_exempt_targets
      x-box-tag: collaboration_allowlist_exempt_targets
    CollaborationAllowlistExemptTarget:
      description: The user that is exempt from any of the restrictions imposed by the list of allowed collaboration domains for this enterprise.
      type: object
      properties:
        id:
          description: The unique identifier for this exemption.
          type: string
          example: '11446498'
        type:
          description: The value will always be `collaboration_whitelist_exempt_target`.
          type: string
          example: collaboration_whitelist_exempt_target
          enum:
          - collaboration_whitelist_exempt_target
        enterprise:
          allOf:
          - title: Enterprise
            type: object
            description: A representation of a Box enterprise.
            properties:
              id:
                description: The unique identifier for this enterprise.
                type: string
                example: '11446498'
              type:
                description: The value will always be `enterprise`.
                type: string
                example: enterprise
                enum:
                - enterprise
              name:
                description: The name of the enterprise.
                type: string
                example: Acme Inc.
          - description: The enterprise this entry belongs to.
        user:
          allOf:
          - $ref: '#/components/schemas/User--Mini'
          - description: The user that has been exempt.
        created_at:
          description: The time the entry was created.
          type: string
          format: date-time
          example: '2012-12-12T10:53:43-08:00'
        modified_at:
          description: The time the entry was modified.
          type: string
          format: date-time
          example: '2012-12-12T10:53:43-08:00'
      title: Allowed collaboration domains user exemption
      x-box-resource-id: collaboration_allowlist_exempt_target
      x-box-tag: collaboration_allowlist_exempt_targets
    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
    User--Mini:
      description: A mini representation of a user, as can be returned when nested within other resources.
      type: object
      allOf:
      - $ref: '#/components/schemas/User--Base'
      - properties:
          name:
            description: The display name of this user.
            type: string
            example: Aaron Levie
            maxLength: 50
          login:
            description: The primary email address of this user.
            type: string
            format: email
            example: ceo@example.com
      title: User (Mini)
      x-box-resource-id: user--mini
      x-box-tag: users
      x-box-variant: mini
    User--Base:
      description: A mini representation of a user, used when nested within another resource.
      type: object
      properties:
        id:
          description: The unique identifier for this user.
          type: string
          example: '11446498'
        type:
          description: The value will always be `user`.
          type: string
          example: user
          enum:
          - user
      required:
      - type
      - id
      title: User (Base)
      x-box-resource-id: user--base
      x-box-tag: users
      x-box-variant: base
      x-box-variants:
      - base
      - mini
      - standard
      - full
  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)