Box

Box Shield Information Barrier Segment Restrictions API

Shield information barrier segment restriction is an access restriction based on the content (file or folder) owner.

Documentation GitHub OpenAPI

Operations 4

GET /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id} Box Get shield information barrier segment restriction by ID #

DELETE /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id} Box Delete shield information barrier segment restriction by ID #

GET /shield_information_barrier_segment_restrictions Box List shield information barrier segment restrictions #

POST /shield_information_barrier_segment_restrictions Box Create shield information barrier segment restriction #

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://raw.githubusercontent.com/api-evangelist/box/refs/heads/main/openapi/box-shield-information-barrier-segment-restrictions-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-shield-information-barrier-segment-restrictions-api"

All apis

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

Discovery needs no key. Ratings and market analysis are Pro.

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 Barrier Segment…
  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://box.dev
    email: devrel@box.com
  license:
    name: Apache-2.0
    url: http://www.apache.org/licenses/LICENSE-2.0
  version: 2.0.0
  x-box-commit-hash: '5819125043'
servers:
- url: https://api.box.com/2.0
  description: Box Platform API server
security:
- OAuth2Security: []
tags:
- name: Shield Information Barrier Segment Restrictions
  description: 'Shield information barrier segment restriction is

    an access restriction based on the content (file or folder) owner.'
  x-box-tag: shield_information_barrier_segment_restrictions
paths:
  /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}:
    get:
      operationId: get_shield_information_barrier_segment_restrictions_id
      summary: Box Get shield information barrier segment restriction by ID
      tags:
      - Shield Information Barrier Segment Restrictions
      x-box-tag: shield_information_barrier_segment_restrictions
      description: 'Retrieves a shield information barrier segment

        restriction based on provided ID.'
      parameters:
      - name: shield_information_barrier_segment_restriction_id
        description: The ID of the shield information barrier segment Restriction.
        example: '4563'
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 'Returns the shield information barrier segment

            restriction object.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierSegmentRestriction'
        '404':
          description: 'Returns a `not_found` error if the

            shield information barrier segment

            restriction 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'
    delete:
      operationId: delete_shield_information_barrier_segment_restrictions_id
      summary: Box Delete shield information barrier segment restriction by ID
      tags:
      - Shield Information Barrier Segment Restrictions
      x-box-tag: shield_information_barrier_segment_restrictions
      description: 'Delete shield information barrier segment restriction

        based on provided ID.'
      parameters:
      - name: shield_information_barrier_segment_restriction_id
        description: The ID of the shield information barrier segment Restriction.
        example: '4563'
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Empty body in response
        '404':
          description: 'Returns a `not_found` error if the

            shield information barrier segment restriction 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'
  /shield_information_barrier_segment_restrictions:
    get:
      operationId: get_shield_information_barrier_segment_restrictions
      summary: Box List shield information barrier segment restrictions
      tags:
      - Shield Information Barrier Segment Restrictions
      x-box-tag: shield_information_barrier_segment_restrictions
      description: 'Lists shield information barrier segment restrictions

        based on provided segment ID.'
      parameters:
      - name: shield_information_barrier_segment_id
        description: The ID of the shield information barrier segment.
        example: '3423'
        required: true
        in: query
        schema:
          type: string
      - name: marker
        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`.'
        in: query
        required: false
        example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
        schema:
          type: string
      - name: limit
        description: The maximum number of items to return per page.
        in: query
        required: false
        example: 1000
        schema:
          type: integer
          format: int64
          maximum: 1000
      responses:
        '200':
          description: 'Returns a paginated list of

            shield information barrier segment restriction objects.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierSegmentRestrictions'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
    post:
      operationId: post_shield_information_barrier_segment_restrictions
      summary: Box Create shield information barrier segment restriction
      tags:
      - Shield Information Barrier Segment Restrictions
      x-box-tag: shield_information_barrier_segment_restrictions
      description: 'Creates a shield information barrier

        segment restriction object.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - type
              - shield_information_barrier_segment
              - restricted_segment
              properties:
                type:
                  type: string
                  description: 'The type of the shield barrier segment

                    restriction for this member.'
                  example: shield_information_barrier_segment_restriction
                  enum:
                  - shield_information_barrier_segment_restriction
                shield_information_barrier:
                  $ref: '#/components/schemas/ShieldInformationBarrier--Base'
                shield_information_barrier_segment:
                  type: object
                  properties:
                    id:
                      type: string
                      example: '1910967'
                      description: 'The ID reference of the requesting

                        shield information barrier segment.'
                    type:
                      type: string
                      description: The type of the shield barrier segment for this member.
                      example: shield_information_barrier_segment
                      enum:
                      - shield_information_barrier_segment
                  description: 'The `type` and `id` of the requested

                    shield information barrier segment.'
                restricted_segment:
                  type: object
                  properties:
                    id:
                      type: string
                      example: '1910967'
                      description: 'The ID reference of the restricted

                        shield information barrier segment.'
                    type:
                      type: string
                      example: shield_information_barrier_segment
                      description: 'The type of the restricted shield

                        information barrier segment.'
                      enum:
                      - shield_information_barrier_segment
                  description: 'The `type` and `id` of the restricted

                    shield information barrier segment.'
      responses:
        '201':
          description: 'Returns the newly created Shield

            Information Barrier Segment Restriction object.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierSegmentRestriction'
        '404':
          description: 'Returns a `not_found` error if the

            shield information barrier or segment 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'
components:
  schemas:
    ShieldInformationBarrierSegmentRestrictions:
      title: List of Shield Information Barrier Segment Restrictions
      type: object
      x-box-resource-id: shield_information_barrier_segment_restrictions
      x-box-tag: shield_information_barrier_segment_restrictions
      description: List of shield information barrier segment restriction objects
      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.'
            example: 1000
            type: integer
            format: int64
          next_marker:
            description: The marker for the start of the next page of results.
            example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
            type:
            - string
            - 'null'
      - properties:
          entries:
            type: array
            description: 'A list of shield information barrier

              segment restriction objects'
            items:
              $ref: '#/components/schemas/ShieldInformationBarrierSegmentRestriction'
    ClientError:
      title: Client error
      type: object
      x-box-resource-id: client_error
      description: A generic error
      properties:
        type:
          description: error
          example: error
          type: string
          enum:
          - error
        status:
          description: The HTTP status of the response.
          example: 400
          type: integer
          format: int32
        code:
          description: A Box-specific error code
          example: item_name_invalid
          type: string
          enum:
          - created
          - accepted
          - no_content
          - redirect
          - not_modified
          - bad_request
          - unauthorized
          - forbidden
          - not_found
          - method_not_allowed
          - conflict
          - precondition_failed
          - too_many_requests
          - internal_server_error
          - unavailable
          - item_name_invalid
          - insufficient_scope
        message:
          description: A short message describing the error.
          example: Method Not Allowed
          type: string
        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'
          properties:
            message:
              type: string
              description: More details on the error.
              example: Something went wrong.
        help_url:
          description: A URL that links to more information about why this error occurred.
          example: https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
          type: string
        request_id:
          description: 'A unique identifier for this response, which can be used

            when contacting Box support.'
          type: string
          example: abcdef123456
    ShieldInformationBarrier--Base:
      title: Shield information barrier (Base)
      type: object
      x-box-resource-id: shield_information_barrier--base
      x-box-tag: shield_information_barriers
      x-box-variants:
      - base
      - standard
      x-box-variant: base
      description: 'A base representation of a

        shield information barrier object'
      properties:
        id:
          type: string
          example: '11446498'
          description: The unique identifier for the shield information barrier
        type:
          type: string
          description: The type of the shield information barrier
          example: shield_information_barrier
          enum:
          - shield_information_barrier
    ShieldInformationBarrierSegmentRestriction--Mini:
      title: Shield information barrier segment restriction (Mini)
      type: object
      x-box-resource-id: shield_information_barrier_segment_restriction--mini
      x-box-tag: shield_information_barrier_segment_restrictions
      x-box-variants:
      - base
      - mini
      - standard
      x-box-variant: mini
      description: 'A mini representation of

        a segment restriction object for

        the shield information barrier'
      required:
      - shield_information_barrier_segment
      - restricted_segment
      allOf:
      - $ref: '#/components/schemas/ShieldInformationBarrierSegmentRestriction--Base'
      - properties:
          shield_information_barrier_segment:
            type: object
            properties:
              id:
                type: string
                example: '1910967'
                description: 'The ID reference of the

                  requesting shield information barrier segment.'
              type:
                type: string
                description: The type of the shield information barrier segment
                example: shield_information_barrier_segment
                enum:
                - shield_information_barrier_segment
            description: 'The `type` and `id` of the

              requested shield information barrier segment.'
          restricted_segment:
            type: object
            properties:
              id:
                type: string
                example: '1910967'
                description: 'The ID reference of the

                  restricted shield information barrier segment.'
              type:
                type: string
                description: The type of the shield information segment
                example: shield_information_barrier_segment
                enum:
                - shield_information_barrier_segment
            description: 'The `type` and `id` of the

              restricted shield information barrier segment.'
    ShieldInformationBarrierSegmentRestriction:
      title: Shield information barrier segment restriction
      type: object
      x-box-resource-id: shield_information_barrier_segment_restriction
      x-box-tag: shield_information_barrier_segment_restrictions
      x-box-variants:
      - base
      - mini
      - standard
      x-box-variant: standard
      description: 'A standard representation of a

        segment restriction of a shield information barrier

        object'
      required:
      - shield_information_barrier_segment
      - restricted_segment
      allOf:
      - $ref: '#/components/schemas/ShieldInformationBarrierSegmentRestriction--Mini'
      - properties:
          shield_information_barrier:
            $ref: '#/components/schemas/ShieldInformationBarrier--Base'
          created_at:
            type: string
            format: date-time
            example: '2020-06-26T18:44:45.869Z'
            description: 'ISO date time string when this

              shield information barrier

              Segment Restriction object was created.'
          created_by:
            allOf:
            - $ref: '#/components/schemas/User--Base'
            - description: The user who created this shield information barrier segment Restriction.
          updated_at:
            type: string
            format: date-time
            example: '2020-07-26T18:44:45.869Z'
            description: 'ISO date time string when this

              shield information barrier segment

              Restriction was updated.'
          updated_by:
            allOf:
            - $ref: '#/components/schemas/User--Base'
            - description: The user that updated this shield information barrier segment Restriction.
    User--Base:
      title: User (Base)
      type: object
      x-box-resource-id: user--base
      x-box-tag: users
      x-box-variants:
      - base
      - mini
      - standard
      - full
      x-box-variant: base
      description: 'A mini representation of a user, used when

        nested within another resource.'
      required:
      - type
      - id
      properties:
        id:
          type: string
          description: The unique identifier for this user
          example: '11446498'
        type:
          type: string
          description: '`user`'
          example: user
          enum:
          - user
    ShieldInformationBarrierSegmentRestriction--Base:
      title: Shield information barrier segment restriction (Base)
      type: object
      x-box-resource-id: shield_information_barrier_segment_restriction--base
      x-box-tag: shield_information_barrier_segment_restrictions
      x-box-variants:
      - base
      - mini
      - standard
      x-box-variant: base
      description: 'A base representation of

        a segment restriction object for

        the shield information barrier'
      required:
      - shield_information_barrier_segment
      - restricted_segment
      properties:
        type:
          type: string
          description: Shield information barrier segment restriction
          example: shield_information_barrier_segment_restriction
          enum:
          - shield_information_barrier_segment_restriction
        id:
          type: string
          example: '11446498'
          description: 'The unique identifier for the

            shield information barrier segment restriction.'
  securitySchemes:
    OAuth2Security:
      type: oauth2
      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