Box

Box Shield Information Barriers API

Shield information barrier in Box defines an ethical wall. An ethical wall is a mechanism that prevents exchanges or communication that could lead to conflicts of interest and therefore result in business activities ethically or legally questionable.

Documentation GitHub OpenAPI

Operations 4

GET /shield_information_barriers/{shield_information_barrier_id} Get shield information barrier with specified ID #

POST /shield_information_barriers/change_status Add changed status of shield information barrier with specified ID #

GET /shield_information_barriers List shield information barriers #

POST /shield_information_barriers Create shield information barrier #

Documentation

https://developer.box.com/reference/get-authorize

https://developer.box.com/reference/post-oauth2-token

https://developer.box.com/reference/post-files-id-copy

https://developer.box.com/reference/post-file-requests-id-copy

https://developer.box.com/reference/post-folders-id-copy

https://developer.box.com/reference/post-folder-locks

https://developer.box.com/reference/post-metadata-templates-schema

https://developer.box.com/reference/post-metadata-cascade-policies

https://developer.box.com/reference/post-metadata-queries-execute-read

https://developer.box.com/reference/post-comments

https://developer.box.com/reference/post-collaborations

https://developer.box.com/reference/post-tasks

https://developer.box.com/reference/post-task-assignments

https://developer.box.com/reference/put-files-id--add-shared-link

https://developer.box.com/reference/put-folders-id--add-shared-link

https://developer.box.com/reference/post-web-links

https://developer.box.com/reference/put-web-links-id--add-shared-link

https://developer.box.com/reference/post-users

https://developer.box.com/reference/post-invites

https://developer.box.com/reference/post-groups

https://developer.box.com/reference/post-group-memberships

https://developer.box.com/reference/post-webhooks

https://developer.box.com/reference/post-files-id-metadata-global-boxSkillsCards

https://developer.box.com/reference/options-events

https://developer.box.com/reference/get-collections-id

https://developer.box.com/reference/get-recent-items

https://developer.box.com/reference/post-retention-policies

https://developer.box.com/reference/post-retention-policy-assignments

https://developer.box.com/reference/post-legal-hold-policies

https://developer.box.com/reference/post-legal-hold-policy-assignments

https://developer.box.com/reference/get-file-version-retentions-id

https://developer.box.com/reference/get-file-version-legal-holds-id

https://developer.box.com/reference/post-shield-information-barriers-change-status

https://developer.box.com/reference/post-shield-information-barrier-reports

https://developer.box.com/reference/post-shield-information-barrier-segments

https://developer.box.com/reference/post-shield-information-barrier-segment-members

https://developer.box.com/reference/post-shield-information-barrier-segment-restrictions

https://developer.box.com/reference/get-device-pinners-id

https://developer.box.com/reference/post-terms-of-services

https://developer.box.com/reference/post-terms-of-service-user-statuses

https://developer.box.com/reference/post-collaboration-whitelist-entries

https://developer.box.com/

Specifications

https://artifacts.apis.io/box/openapi/box-shield-information-barriers-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/box:box-shield-information-barriers-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Box Platform Shield information barriers 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: Shield information barriers
  description: Shield information barrier in Box defines an ethical wall. An ethical wall is a mechanism that prevents exchanges or communication that could lead to conflicts of interest and therefore result in business activities ethically or legally questionable.
  x-box-tag: shield_information_barriers
paths:
  /shield_information_barriers/{shield_information_barrier_id}:
    get:
      operationId: get_shield_information_barriers_id
      summary: Get shield information barrier with specified ID
      description: Get shield information barrier based on provided ID.
      parameters:
      - name: shield_information_barrier_id
        in: path
        description: The ID of the shield information barrier.
        required: true
        schema:
          type: string
        example: '1910967'
      responses:
        '200':
          description: Returns the shield information barrier object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrier'
        '404':
          description: Returns a `not_found` error if the shield information barrier was not found.
          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: shield_information_barriers
      tags:
      - Shield information barriers
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Get shield information barrier with specified ID
        source: "curl -i -X GET \"https://api.box.com/2.0/shield_information_barriers/1910967\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Get shield information barrier with specified ID
        source: 'await client.ShieldInformationBarriers.GetShieldInformationBarrierByIdAsync(shieldInformationBarrierId: barrierId);'
      - lang: swift
        label: Get shield information barrier with specified ID
        source: 'try await client.shieldInformationBarriers.getShieldInformationBarrierById(shieldInformationBarrierId: barrierId)'
      - lang: java
        label: Get shield information barrier with specified ID
        source: client.getShieldInformationBarriers().getShieldInformationBarrierById(barrierId)
      - lang: node
        label: Get shield information barrier with specified ID
        source: "await client.shieldInformationBarriers.getShieldInformationBarrierById(\n  barrierId,\n);"
      - lang: python
        label: Get shield information barrier with specified ID
        source: client.shield_information_barriers.get_shield_information_barrier_by_id(barrier_id)
  /shield_information_barriers/change_status:
    post:
      operationId: post_shield_information_barriers_change_status
      summary: Add changed status of shield information barrier with specified ID
      description: Change status of shield information barrier with the specified ID.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: The ID of the shield information barrier.
                  type: string
                  example: '1910967'
                status:
                  description: The desired status for the shield information barrier.
                  type: string
                  example: pending
                  enum:
                  - pending
                  - disabled
              required:
              - id
              - status
      responses:
        '200':
          description: Returns the updated shield information barrier object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrier'
        '404':
          description: Returns a `not_found` error if the shield information barrier was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '409':
          description: Returns an error if there exists Conflicts with existing information barriers.
          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: shield_information_barriers
      tags:
      - Shield information barriers
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Add changed status of shield information barrier with specified ID
        source: "curl -i -X POST \"https://api.box.com/2.0/shield_information_barriers/change_status\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"id\": \"1910967\",\n       \"status\": \"pending\"\n     }'"
      - lang: dotnet
        label: Add changed status of shield information barrier with specified ID
        source: 'await client.ShieldInformationBarriers.UpdateShieldInformationBarrierStatusAsync(requestBody: new UpdateShieldInformationBarrierStatusRequestBody(id: barrierId, status: UpdateShieldInformationBarrierStatusRequestBodyStatusField.Disabled));'
      - lang: swift
        label: Add changed status of shield information barrier with specified ID
        source: 'try await client.shieldInformationBarriers.updateShieldInformationBarrierStatus(requestBody: UpdateShieldInformationBarrierStatusRequestBody(id: barrierId, status: UpdateShieldInformationBarrierStatusRequestBodyStatusField.disabled))'
      - lang: java
        label: Add changed status of shield information barrier with specified ID
        source: client.getShieldInformationBarriers().updateShieldInformationBarrierStatus(new UpdateShieldInformationBarrierStatusRequestBody(barrierId, UpdateShieldInformationBarrierStatusRequestBodyStatusField.DISABLED))
      - lang: node
        label: Add changed status of shield information barrier with specified ID
        source: "await client.shieldInformationBarriers.updateShieldInformationBarrierStatus({\n  id: barrierId,\n  status:\n    'disabled' as UpdateShieldInformationBarrierStatusRequestBodyStatusField,\n} satisfies UpdateShieldInformationBarrierStatusRequestBody);"
      - lang: python
        label: Add changed status of shield information barrier with specified ID
        source: "client.shield_information_barriers.update_shield_information_barrier_status(\n    barrier_id, UpdateShieldInformationBarrierStatusStatus.DISABLED\n)"
  /shield_information_barriers:
    get:
      operationId: get_shield_information_barriers
      summary: List shield information barriers
      description: Retrieves a list of shield information barrier objects for the enterprise of JWT.
      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.
        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 paginated list of shield information barrier objects, empty list if currently no barrier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarriers'
        '404':
          description: Returns a `not_found` error if could not find an enterprise using JWT.
          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: shield_information_barriers
      tags:
      - Shield information barriers
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: List shield information barriers
        source: "curl -i -X GET \"https://api.box.com/2.0/shield_information_barriers\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: List shield information barriers
        source: await client.ShieldInformationBarriers.GetShieldInformationBarriersAsync();
      - lang: swift
        label: List shield information barriers
        source: try await client.shieldInformationBarriers.getShieldInformationBarriers()
      - lang: java
        label: List shield information barriers
        source: client.getShieldInformationBarriers().getShieldInformationBarriers()
      - lang: node
        label: List shield information barriers
        source: await client.shieldInformationBarriers.getShieldInformationBarriers();
      - lang: python
        label: List shield information barriers
        source: client.shield_information_barriers.get_shield_information_barriers()
    post:
      operationId: post_shield_information_barriers
      summary: Create shield information barrier
      description: Creates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enterprise:
                  description: The `type` and `id` of enterprise this barrier is under.
                  allOf:
                  - $ref: '#/components/schemas/Enterprise--Base'
              required:
              - enterprise
      responses:
        '201':
          description: Returns a new shield information barrier object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrier'
        '400':
          description: Returns an error if the enterprise is missing from the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '404':
          description: Returns an error when an incorrect or null enterprise is present in the request body.
          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: shield_information_barriers
      tags:
      - Shield information barriers
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Create shield information barrier
        source: "curl -i -X POST \"https://api.box.com/2.0/shield_information_barriers\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"enterprise\": {\n         \"id\": \"1910967\",\n         \"type\": \"enterprise\"\n       }\n     }'"
      - lang: dotnet
        label: Create shield information barrier
        source: 'await client.ShieldInformationBarriers.CreateShieldInformationBarrierAsync(requestBody: new CreateShieldInformationBarrierRequestBody(enterprise: new EnterpriseBase() { Id = enterpriseId }));'
      - lang: swift
        label: Create shield information barrier
        source: 'try await client.shieldInformationBarriers.createShieldInformationBarrier(requestBody: CreateShieldInformationBarrierRequestBody(enterprise: EnterpriseBase(id: enterpriseId)))'
      - lang: java
        label: Create shield information barrier
        source: client.getShieldInformationBarriers().createShieldInformationBarrier(new CreateShieldInformationBarrierRequestBody(new EnterpriseBase.Builder().id(enterpriseId).build()))
      - lang: node
        label: Create shield information barrier
        source: "await client.shieldInformationBarriers.createShieldInformationBarrier({\n  enterprise: { id: enterpriseId } satisfies EnterpriseBase,\n} satisfies CreateShieldInformationBarrierRequestBody);"
      - lang: python
        label: Create shield information barrier
        source: "client.shield_information_barriers.create_shield_information_barrier(\n    EnterpriseBase(id=enterprise_id)\n)"
components:
  schemas:
    Enterprise--Base:
      description: A representation of a enterprise, used when nested within another resource.
      type: object
      properties:
        id:
          description: The unique identifier for this enterprise.
          type: string
          example: '1910967'
        type:
          description: The value will always be `enterprise`.
          type: string
          example: enterprise
          enum:
          - enterprise
      title: Enterprise
      x-box-resource-id: enterprise--base
    ShieldInformationBarrier:
      description: A standard representation of a shield information barrier object.
      type: object
      properties:
        id:
          description: The unique identifier for the shield information barrier.
          type: string
          example: '11446498'
        type:
          description: The type of the shield information barrier.
          type: string
          example: shield_information_barrier
          enum:
          - shield_information_barrier
        enterprise:
          description: The `type` and `id` of enterprise this barrier is under.
          allOf:
          - $ref: '#/components/schemas/Enterprise--Base'
        status:
          description: Status of the shield information barrier.
          type: string
          example: draft
          enum:
          - draft
          - pending
          - disabled
          - enabled
          - invalid
        created_at:
          description: ISO date time string when this shield information barrier object was created.
          type: string
          format: date-time
          example: '2020-06-26T18:44:45.869Z'
        created_by:
          description: The user who created this shield information barrier.
          allOf:
          - $ref: '#/components/schemas/User--Base'
        updated_at:
          description: ISO date time string when this shield information barrier was updated.
          type: string
          format: date-time
          example: '2020-07-26T18:44:45.869Z'
        updated_by:
          description: The user that updated this shield information barrier.
          allOf:
          - $ref: '#/components/schemas/User--Base'
        enabled_at:
          description: ISO date time string when this shield information barrier was enabled.
          type: string
          format: date-time
          example: '2020-07-26T18:44:45.869Z'
        enabled_by:
          allOf:
          - $ref: '#/components/schemas/User--Base'
          - description: The user that enabled this shield information barrier.
      title: Shield information barrier
      x-box-resource-id: shield_information_barrier
      x-box-tag: shield_information_barriers
      x-box-variant: standard
      x-box-variants:
      - base
      - standard
    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
    ShieldInformationBarriers:
      description: List of Shield Information Barrier objects.
      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
      - properties:
          entries:
            description: A list of shield information barrier objects.
            type: array
            items:
              $ref: '#/components/schemas/ShieldInformationBarrier'
      title: List of Shield Information Barriers
      x-box-resource-id: shield_information_barriers
      x-box-tag: shield_information_barriers
    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)