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} Get shield information barrier segment restriction by ID #

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

GET /shield_information_barrier_segment_restrictions List shield information barrier segment restrictions #

POST /shield_information_barrier_segment_restrictions 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://artifacts.apis.io/box/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:box-shield-information-barrier-segment-restrictions-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 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://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 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: Get shield information barrier segment restriction by ID
      description: Retrieves a shield information barrier segment restriction based on provided ID.
      parameters:
      - name: shield_information_barrier_segment_restriction_id
        in: path
        description: The ID of the shield information barrier segment Restriction.
        required: true
        schema:
          type: string
        example: '4563'
      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'
      x-box-tag: shield_information_barrier_segment_restrictions
      tags:
      - Shield information barrier segment restrictions
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Get shield information barrier segment restriction by ID
        source: "curl -i -X GET \"https://api.box.com/2.0/shield_information_barrier_segment_restrictions/4563\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Get shield information barrier segment restriction by ID
        source: 'await client.ShieldInformationBarrierSegmentRestrictions.GetShieldInformationBarrierSegmentRestrictionByIdAsync(shieldInformationBarrierSegmentRestrictionId: segmentRestrictionId);'
      - lang: swift
        label: Get shield information barrier segment restriction by ID
        source: 'try await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictionById(shieldInformationBarrierSegmentRestrictionId: segmentRestrictionId)'
      - lang: java
        label: Get shield information barrier segment restriction by ID
        source: client.getShieldInformationBarrierSegmentRestrictions().getShieldInformationBarrierSegmentRestrictionById(segmentRestrictionId)
      - lang: node
        label: Get shield information barrier segment restriction by ID
        source: "await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictionById(\n  segmentRestrictionId,\n);"
      - lang: python
        label: Get shield information barrier segment restriction by ID
        source: "client.shield_information_barrier_segment_restrictions.get_shield_information_barrier_segment_restriction_by_id(\n    segment_restriction_id\n)"
    delete:
      operationId: delete_shield_information_barrier_segment_restrictions_id
      summary: Delete shield information barrier segment restriction by ID
      description: Delete shield information barrier segment restriction based on provided ID.
      parameters:
      - name: shield_information_barrier_segment_restriction_id
        in: path
        description: The ID of the shield information barrier segment Restriction.
        required: true
        schema:
          type: string
        example: '4563'
      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'
      x-box-tag: shield_information_barrier_segment_restrictions
      tags:
      - Shield information barrier segment restrictions
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Delete shield information barrier segment restriction by ID
        source: "curl -i -X DELETE \"https://api.box.com/2.0/shield_information_barrier_segment_restrictions/4563\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Delete shield information barrier segment restriction by ID
        source: 'await client.ShieldInformationBarrierSegmentRestrictions.DeleteShieldInformationBarrierSegmentRestrictionByIdAsync(shieldInformationBarrierSegmentRestrictionId: segmentRestrictionId);'
      - lang: swift
        label: Delete shield information barrier segment restriction by ID
        source: 'try await client.shieldInformationBarrierSegmentRestrictions.deleteShieldInformationBarrierSegmentRestrictionById(shieldInformationBarrierSegmentRestrictionId: segmentRestrictionId)'
      - lang: java
        label: Delete shield information barrier segment restriction by ID
        source: client.getShieldInformationBarrierSegmentRestrictions().deleteShieldInformationBarrierSegmentRestrictionById(segmentRestrictionId)
      - lang: node
        label: Delete shield information barrier segment restriction by ID
        source: "await client.shieldInformationBarrierSegmentRestrictions.deleteShieldInformationBarrierSegmentRestrictionById(\n  segmentRestrictionId,\n);"
      - lang: python
        label: Delete shield information barrier segment restriction by ID
        source: "client.shield_information_barrier_segment_restrictions.delete_shield_information_barrier_segment_restriction_by_id(\n    segment_restriction_id\n)"
  /shield_information_barrier_segment_restrictions:
    get:
      operationId: get_shield_information_barrier_segment_restrictions
      summary: List shield information barrier segment restrictions
      description: Lists shield information barrier segment restrictions based on provided segment ID.
      parameters:
      - name: shield_information_barrier_segment_id
        in: query
        description: The ID of the shield information barrier segment.
        required: true
        schema:
          type: string
        example: '3423'
      - 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 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'
      x-box-tag: shield_information_barrier_segment_restrictions
      tags:
      - Shield information barrier segment restrictions
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: List shield information barrier segment restrictions
        source: "curl -i -X GET \"https://api.box.com/2.0/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=3423\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: List shield information barrier segment restrictions
        source: 'await client.ShieldInformationBarrierSegmentRestrictions.GetShieldInformationBarrierSegmentRestrictionsAsync(queryParams: new GetShieldInformationBarrierSegmentRestrictionsQueryParams(shieldInformationBarrierSegmentId: segmentId));'
      - lang: swift
        label: List shield information barrier segment restrictions
        source: 'try await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictions(queryParams: GetShieldInformationBarrierSegmentRestrictionsQueryParams(shieldInformationBarrierSegmentId: segmentId))'
      - lang: java
        label: List shield information barrier segment restrictions
        source: client.getShieldInformationBarrierSegmentRestrictions().getShieldInformationBarrierSegmentRestrictions(new GetShieldInformationBarrierSegmentRestrictionsQueryParams(segmentId))
      - lang: node
        label: List shield information barrier segment restrictions
        source: "await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictions(\n  {\n    shieldInformationBarrierSegmentId: segmentId,\n  } satisfies GetShieldInformationBarrierSegmentRestrictionsQueryParams,\n);"
      - lang: python
        label: List shield information barrier segment restrictions
        source: "client.shield_information_barrier_segment_restrictions.get_shield_information_barrier_segment_restrictions(\n    segment_id\n)"
    post:
      operationId: post_shield_information_barrier_segment_restrictions
      summary: Create shield information barrier segment restriction
      description: Creates a shield information barrier segment restriction object.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  description: The type of the shield barrier segment restriction for this member.
                  type: string
                  example: shield_information_barrier_segment_restriction
                  enum:
                  - shield_information_barrier_segment_restriction
                shield_information_barrier:
                  $ref: '#/components/schemas/ShieldInformationBarrier--Base'
                shield_information_barrier_segment:
                  description: The `type` and `id` of the requested shield information barrier segment.
                  type: object
                  properties:
                    id:
                      description: The ID reference of the requesting shield information barrier segment.
                      type: string
                      example: '1910967'
                    type:
                      description: The type of the shield barrier segment for this member.
                      type: string
                      example: shield_information_barrier_segment
                      enum:
                      - shield_information_barrier_segment
                restricted_segment:
                  description: The `type` and `id` of the restricted shield information barrier segment.
                  type: object
                  properties:
                    id:
                      description: The ID reference of the restricted shield information barrier segment.
                      type: string
                      example: '1910967'
                    type:
                      description: The type of the restricted shield information barrier segment.
                      type: string
                      example: shield_information_barrier_segment
                      enum:
                      - shield_information_barrier_segment
              required:
              - type
              - shield_information_barrier_segment
              - restricted_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'
      x-box-tag: shield_information_barrier_segment_restrictions
      tags:
      - Shield information barrier segment restrictions
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Create shield information barrier segment restriction
        source: "curl -i -X POST \"https://api.box.com/2.0/shield_information_barrier_segment_restrictions\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"type\": \"shield_information_barrier_segment_restriction\",\n       \"shield_information_barrier_segment\": {\n         \"id\": \"1910967\",\n         \"type\": \"shield_information_barrier_segment\"\n       },\n       \"restricted_segment\": {\n         \"id\": \"1910967\",\n         \"type\": \"shield_information_barrier_segment\"\n       }\n     }'"
      - lang: dotnet
        label: Create shield information barrier segment restriction
        source: 'await client.ShieldInformationBarrierSegmentRestrictions.CreateShieldInformationBarrierSegmentRestrictionAsync(requestBody: new CreateShieldInformationBarrierSegmentRestrictionRequestBody(restrictedSegment: new CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField() { Id = segmentToRestrictId, Type = CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField.ShieldInformationBarrierSegment }, shieldInformationBarrierSegment: new CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField() { Id = segmentId, Type = CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField.ShieldInformationBarrierSegment }, type: CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField.ShieldInformationBarrierSegmentRestriction));'
      - lang: swift
        label: Create shield information barrier segment restriction
        source: 'try await client.shieldInformationBarrierSegmentRestrictions.createShieldInformationBarrierSegmentRestriction(requestBody: CreateShieldInformationBarrierSegmentRestrictionRequestBody(restrictedSegment: CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField(id: segmentToRestrictId, type: CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField.shieldInformationBarrierSegment), shieldInformationBarrierSegment: CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField(id: segmentId, type: CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField.shieldInformationBarrierSegment), type: CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField.shieldInformationBarrierSegmentRestriction))'
      - lang: java
        label: Create shield information barrier segment restriction
        source: client.getShieldInformationBarrierSegmentRestrictions().createShieldInformationBarrierSegmentRestriction(new CreateShieldInformationBarrierSegmentRestrictionRequestBody.Builder(new CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField.Builder().id(segmentId).type(CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField.SHIELD_INFORMATION_BARRIER_SEGMENT).build(), new CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField.Builder().id(segmentToRestrictId).type(CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField.SHIELD_INFORMATION_BARRIER_SEGMENT).build()).type(CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField.SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION).build())
      - lang: node
        label: Create shield information barrier segment restriction
        source: "await client.shieldInformationBarrierSegmentRestrictions.createShieldInformationBarrierSegmentRestriction(\n  {\n    restrictedSegment: {\n      id: segmentToRestrictId,\n      type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField,\n    } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField,\n    shieldInformationBarrierSegment: {\n      id: segmentId,\n      type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField,\n    } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField,\n    type: 'shield_information_barrier_segment_restriction' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField,\n  } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyInput,\n);"
      - lang: python
        label: Create shield information barrier segment restriction
        source: "client.shield_information_barrier_segment_restrictions.create_shield_information_barrier_segment_restriction(\n    CreateShieldInformationBarrierSegmentRestrictionShieldInformationBarrierSegment(\n        id=segment_id,\n        type=CreateShieldInformationBarrierSegmentRestrictionShieldInformationBarrierSegmentTypeField.SHIELD_INFORMATION_BARRIER_SEGMENT,\n    ),\n    CreateShieldInformationBarrierSegmentRestrictionRestrictedSegment(\n        id=segment_to_restrict_id,\n        type=CreateShieldInformationBarrierSegmentRestrictionRestrictedSegmentTypeField.SHIELD_INFORMATION_BARRIER_SEGMENT,\n    ),\n    type=CreateShieldInformationBarrierSegmentRestrictionType.SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION,\n)"
components:
  schemas:
    ShieldInformationBarrierSegmentRestriction--Mini:
      description: A mini representation of a segment restriction object for the shield information barrier.
      type: object
      allOf:
      - $ref: '#/components/schemas/ShieldInformationBarrierSegmentRestriction--Base'
      - properties:
          shield_information_barrier_segment:
            description: The `type` and `id` of the requested shield information barrier segment.
            type: object
            properties:
              id:
                description: The ID reference of the requesting shield information barrier segment.
                type: string
                example: '1910967'
              type:
                description: The type of the shield information barrier segment.
                type: string
                example: shield_information_barrier_segment
                enum:
                - shield_information_barrier_segment
          restricted_segment:
            description: The `type` and `id` of the restricted shield information barrier segment.
            type: object
            properties:
              id:
                description: The ID reference of the restricted shield information barrier segment.
                type: string
                example: '1910967'
              type:
                description: The type of the shield information segment.
                type: string
                example: shield_information_barrier_segment
                enum:
                - shield_information_barrier_segment
      required:
      - shield_information_barrier_segment
      - restricted_segment
      title: Shield information barrier segment restriction (Mini)
      x-box-resource-id: shield_information_barrier_segment_restriction--mini
      x-box-tag: shield_information_barrier_segment_restrictions
      x-box-variant: mini
      x-box-variants:
      - base
      - mini
      - standard
    ShieldInformationBarrierSegmentRestrictions:
      description: List of shield information barrier segment restriction 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 segment restriction objects.
            type: array
            items:
              $ref: '#/components/schemas/ShieldInformationBarrierSegmentRestriction'
      title: List of Shield Information Barrier Segment Restrictions
      x-box-resource-id: shield_information_barrier_segment_restrictions
      x-box-tag: shield_information_barrier_segment_restrictions
    ShieldInformationBarrier--Base:
      description: A base 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
      title: Shield information barrier (Base)
      x-box-resource-id: shield_information_barrier--base
      x-box-tag: shield_information_barriers
      x-box-variant: base
      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
    ShieldInformationBarrierSegmentRestriction--Base:
      description: A base representation of a segment restriction object for the shield information barrier.
      type: object
      properties:
        type:
          description: Shield information barrier segment restriction.
          type: string
          example: shield_information_barrier_segment_restriction
          enum:
          - shield_information_barrier_segment_restriction
        id:
          description: The unique identifier for the shield information barrier segment restriction.
          type: string
          example: '11446498'
      required:
      - shield_information_barrier_segment
      - restricted_segment
      title: Shield information barrier segment restriction (Base)
      x-box-resource-id: shield_information_barrier_segment_restriction--base
      x-box-tag: shield_information_barrier_segment_restrictions
      x-box-variant: base
      x-box-variants:
      - base
      - mini
      - standard
    ShieldInformationBarrierSegmentRestriction:
      description: A standard representation of a segment restriction of a shield information barrier object.
      type: object
      allOf:
      - $ref: '#/components/schemas/ShieldInformationBarrierSegmentRestriction--Mini'
      - properties:
          shield_information_barrier:
            $ref: '#/components/schemas/ShieldInformationBarrier--Base'
          created_at:
            description: ISO date time string when this shield information barrier Segment Restriction object was created.
            type: string
            format: date-time
            example: '2020-06-26T18:44:45.869Z'
          created_by:
            allOf:
            - $ref: '#/components/schemas/User--Base'
            - description: The user who created this shield information barrier segment Restriction.
          updated_at:
            description: ISO date time string when this shield information barrier segment Restriction was updated.
            type: string
            format: date-time
            example: '2020-07-26T18:44:45.869Z'
          updated_by:
            allOf:
            - $ref: '#/components/schemas/User--Base'
            - description: The user that updated this shield information barrier segment Restriction.
      required:
      - shield_information_barrier_segment
      - restricted_segment
      title: Shield information barrier segment restriction
      x-box-resource-id: shield_information_barrier_segment_restriction
      x-box-tag: shield_information_barrier_segment_restrictions
      x-box-variant: standard
      x-box-variants:
      - base
      - mini
      - standard
    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)