Box Shield Information Barrier Segments API

openapi: 3.2.0
info:
  title: Box Platform Shield information barrier segments 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 barrier segments
  description: Shield information barrier segment represents a defined group of users. A user can be a member of only one segment, which makes segments different from groups.
  x-box-tag: shield_information_barrier_segments
paths:
  /shield_information_barrier_segments/{shield_information_barrier_segment_id}:
    get:
      operationId: get_shield_information_barrier_segments_id
      summary: Get shield information barrier segment with specified ID
      description: Retrieves shield information barrier segment based on provided ID..
      parameters:
      - name: shield_information_barrier_segment_id
        in: path
        description: The ID of the shield information barrier segment.
        required: true
        schema:
          type: string
        example: '3423'
      responses:
        '200':
          description: Returns the shield information barrier segment object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierSegment'
        '404':
          description: Returns a `not_found` error if the shield information barrier 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_segments
      tags:
      - Shield information barrier segments
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Get shield information barrier segment with specified ID
        source: "curl -i -X GET \"https://api.box.com/2.0/shield_information_barrier_segments/3423\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Get shield information barrier segment with specified ID
        source: 'await client.ShieldInformationBarrierSegments.GetShieldInformationBarrierSegmentByIdAsync(shieldInformationBarrierSegmentId: segmentId);'
      - lang: swift
        label: Get shield information barrier segment with specified ID
        source: 'try await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegmentById(shieldInformationBarrierSegmentId: segmentId)'
      - lang: java
        label: Get shield information barrier segment with specified ID
        source: client.getShieldInformationBarrierSegments().getShieldInformationBarrierSegmentById(segmentId)
      - lang: node
        label: Get shield information barrier segment with specified ID
        source: "await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegmentById(\n  segmentId,\n);"
      - lang: python
        label: Get shield information barrier segment with specified ID
        source: "client.shield_information_barrier_segments.get_shield_information_barrier_segment_by_id(\n    segment_id\n)"
    delete:
      operationId: delete_shield_information_barrier_segments_id
      summary: Delete shield information barrier segment
      description: Deletes the shield information barrier segment based on provided ID.
      parameters:
      - name: shield_information_barrier_segment_id
        in: path
        description: The ID of the shield information barrier segment.
        required: true
        schema:
          type: string
        example: '3423'
      responses:
        '204':
          description: Empty body in response.
        '404':
          description: Returns a `not_found` error if the shield information barrier segment with specified ID 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_segments
      tags:
      - Shield information barrier segments
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Delete shield information barrier segment
        source: "curl -i -X DELETE \"https://api.box.com/2.0/shield_information_barrier_segments/3423\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Delete shield information barrier segment
        source: 'await client.ShieldInformationBarrierSegments.DeleteShieldInformationBarrierSegmentByIdAsync(shieldInformationBarrierSegmentId: segmentId);'
      - lang: swift
        label: Delete shield information barrier segment
        source: 'try await client.shieldInformationBarrierSegments.deleteShieldInformationBarrierSegmentById(shieldInformationBarrierSegmentId: segmentId)'
      - lang: java
        label: Delete shield information barrier segment
        source: client.getShieldInformationBarrierSegments().deleteShieldInformationBarrierSegmentById(segmentId)
      - lang: node
        label: Delete shield information barrier segment
        source: "await client.shieldInformationBarrierSegments.deleteShieldInformationBarrierSegmentById(\n  segmentId,\n);"
      - lang: python
        label: Delete shield information barrier segment
        source: "client.shield_information_barrier_segments.delete_shield_information_barrier_segment_by_id(\n    segment_id\n)"
    put:
      operationId: put_shield_information_barrier_segments_id
      summary: Update shield information barrier segment with specified ID
      description: Updates the shield information barrier segment based on provided ID..
      parameters:
      - name: shield_information_barrier_segment_id
        in: path
        description: The ID of the shield information barrier segment.
        required: true
        schema:
          type: string
        example: '3423'
      requestBody:
        content:
          application/json:
            schema:
              description: An object containing update(s) to be made on the Shield Information Barrier Segment. Possible properties include 'name' and 'description', the value in object is the update.
              type: object
              properties:
                name:
                  description: The updated name for the shield information barrier segment.
                  type: string
                  example: Investment Banking
                  pattern: \S+
                description:
                  description: The updated description for the shield information barrier segment.
                  type:
                  - string
                  - 'null'
                  example: '''Corporate division that engages in advisory_based

                    financial transactions on behalf of individuals,

                    corporations, and governments.'''
      responses:
        '200':
          description: Returns the updated shield information barrier segment object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierSegment'
        '404':
          description: Returns a `not_found` error if the shield information Barrier Segment was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '409':
          description: Returns an error if there exists a shield information Barrier Segment with the same name.
          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_segments
      tags:
      - Shield information barrier segments
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Update shield information barrier segment with specified ID
        source: "curl -i -X PUT \"https://api.box.com/2.0/shield_information_barrier_segments/3423\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"name\": \"Investment Banking\",\n       \"description\": \"Corporate division that engages in advisory-based financial transactions on behalf of individuals, corporations, and governments.\"\n     }'"
      - lang: dotnet
        label: Update shield information barrier segment with specified ID
        source: 'await client.ShieldInformationBarrierSegments.UpdateShieldInformationBarrierSegmentByIdAsync(shieldInformationBarrierSegmentId: segmentId, requestBody: new UpdateShieldInformationBarrierSegmentByIdRequestBody() { Description = updatedSegmentDescription });'
      - lang: swift
        label: Update shield information barrier segment with specified ID
        source: 'try await client.shieldInformationBarrierSegments.updateShieldInformationBarrierSegmentById(shieldInformationBarrierSegmentId: segmentId, requestBody: UpdateShieldInformationBarrierSegmentByIdRequestBody(description: updatedSegmentDescription))'
      - lang: java
        label: Update shield information barrier segment with specified ID
        source: client.getShieldInformationBarrierSegments().updateShieldInformationBarrierSegmentById(segmentId, new UpdateShieldInformationBarrierSegmentByIdRequestBody.Builder().description(updatedSegmentDescription).build())
      - lang: node
        label: Update shield information barrier segment with specified ID
        source: "await client.shieldInformationBarrierSegments.updateShieldInformationBarrierSegmentById(\n  segmentId,\n  {\n    requestBody: {\n      description: updatedSegmentDescription,\n    } satisfies UpdateShieldInformationBarrierSegmentByIdRequestBody,\n  } satisfies UpdateShieldInformationBarrierSegmentByIdOptionalsInput,\n);"
      - lang: python
        label: Update shield information barrier segment with specified ID
        source: "client.shield_information_barrier_segments.update_shield_information_barrier_segment_by_id(\n    segment_id, description=updated_segment_description\n)"
  /shield_information_barrier_segments:
    get:
      operationId: get_shield_information_barrier_segments
      summary: List shield information barrier segments
      description: Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID.
      parameters:
      - name: shield_information_barrier_id
        in: query
        description: The ID of the shield information barrier.
        required: true
        schema:
          type: string
        example: '1910967'
      - 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 objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierSegments'
        '404':
          description: Returns a `not_found` error if the shield information Barrier of given ID 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_segments
      tags:
      - Shield information barrier segments
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: List shield information barrier segments
        source: "curl -i -X GET \"https://api.box.com/2.0/shield_information_barrier_segments?shield_information_barrier_id=1910967\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: List shield information barrier segments
        source: 'await client.ShieldInformationBarrierSegments.GetShieldInformationBarrierSegmentsAsync(queryParams: new GetShieldInformationBarrierSegmentsQueryParams(shieldInformationBarrierId: barrierId));'
      - lang: swift
        label: List shield information barrier segments
        source: 'try await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegments(queryParams: GetShieldInformationBarrierSegmentsQueryParams(shieldInformationBarrierId: barrierId))'
      - lang: java
        label: List shield information barrier segments
        source: client.getShieldInformationBarrierSegments().getShieldInformationBarrierSegments(new GetShieldInformationBarrierSegmentsQueryParams(barrierId))
      - lang: node
        label: List shield information barrier segments
        source: "await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegments(\n  {\n    shieldInformationBarrierId: barrierId,\n  } satisfies GetShieldInformationBarrierSegmentsQueryParams,\n);"
      - lang: python
        label: List shield information barrier segments
        source: "client.shield_information_barrier_segments.get_shield_information_barrier_segments(\n    barrier_id\n)"
    post:
      operationId: post_shield_information_barrier_segments
      summary: Create shield information barrier segment
      description: Creates a shield information barrier segment.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                shield_information_barrier:
                  $ref: '#/components/schemas/ShieldInformationBarrier--Base'
                name:
                  description: Name of the shield information barrier segment.
                  type: string
                  example: Investment Banking
                description:
                  description: Description of the shield information barrier segment.
                  type: string
                  example: "'Corporate division that engages in\n advisory_based financial\ntransactions on behalf of individuals,\ncorporations, and governments.'"
              required:
              - shield_information_barrier
              - name
      responses:
        '201':
          description: Returns a new shield information barrier segment object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierSegment'
        '404':
          description: Returns an 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 an shield information barrier segment with same name.
          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_segments
      tags:
      - Shield information barrier segments
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Create shield information barrier segment
        source: "curl -i -X POST \"https://api.box.com/2.0/shield_information_barrier_segments\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"shield_information_barrier\": {\n         \"id\": \"11446498\",\n         \"type\": \"shield_information_barrier\"\n       },\n       \"name\": \"Investment Banking\"\n     }'"
      - lang: dotnet
        label: Create shield information barrier segment
        source: 'await client.ShieldInformationBarrierSegments.CreateShieldInformationBarrierSegmentAsync(requestBody: new CreateShieldInformationBarrierSegmentRequestBody(shieldInformationBarrier: new ShieldInformationBarrierBase() { Id = barrierId, Type = ShieldInformationBarrierBaseTypeField.ShieldInformationBarrier }, name: segmentName) { Description = segmentDescription });'
      - lang: swift
        label: Create shield information barrier segment
        source: 'try await client.shieldInformationBarrierSegments.createShieldInformationBarrierSegment(requestBody: CreateShieldInformationBarrierSegmentRequestBody(shieldInformationBarrier: ShieldInformationBarrierBase(id: barrierId, type: ShieldInformationBarrierBaseTypeField.shieldInformationBarrier), name: segmentName, description: segmentDescription))'
      - lang: java
        label: Create shield information barrier segment
        source: client.getShieldInformationBarrierSegments().createShieldInformationBarrierSegment(new CreateShieldInformationBarrierSegmentRequestBody.Builder(new ShieldInformationBarrierBase.Builder().id(barrierId).type(ShieldInformationBarrierBaseTypeField.SHIELD_INFORMATION_BARRIER).build(), segmentName).description(segmentDescription).build())
      - lang: node
        label: Create shield information barrier segment
        source: "await client.shieldInformationBarrierSegments.createShieldInformationBarrierSegment(\n  {\n    shieldInformationBarrier: {\n      id: barrierId,\n      type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField,\n    } satisfies ShieldInformationBarrierBase,\n    name: segmentName,\n    description: segmentDescription,\n  } satisfies CreateShieldInformationBarrierSegmentRequestBody,\n);"
      - lang: python
        label: Create shield information barrier segment
        source: "client.shield_information_barrier_segments.create_shield_information_barrier_segment(\n    ShieldInformationBarrierBase(\n        id=barrier_id,\n        type=ShieldInformationBarrierBaseTypeField.SHIELD_INFORMATION_BARRIER,\n    ),\n    segment_name,\n    description=segment_description,\n)"
components:
  schemas:
    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
    ShieldInformationBarrierSegment:
      description: A shield information barrier segment object.
      type: object
      properties:
        id:
          description: The unique identifier for the shield information barrier segment.
          type: string
          example: '11446498'
        type:
          description: The type of the shield information barrier segment.
          type: string
          example: shield_information_barrier_segment
          enum:
          - shield_information_barrier_segment
        shield_information_barrier:
          $ref: '#/components/schemas/ShieldInformationBarrier--Base'
        name:
          description: Name of the shield information barrier segment.
          type: string
          example: Investment Banking
        description:
          description: Description of the shield information barrier segment.
          type: string
          example: "'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'"
        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:
          allOf:
          - $ref: '#/components/schemas/User--Base'
          - description: The user who created this shield information barrier segment.
        updated_at:
          description: ISO date time string when this shield information barrier segment 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.
      title: Shield information barrier segment
      x-box-resource-id: shield_information_barrier_segment
      x-box-tag: shield_information_barrier_segments
    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
    ShieldInformationBarrierSegments:
      description: List of Shield Information Barrier Segment 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 segments.
            type: array
            items:
              $ref: '#/components/schemas/ShieldInformationBarrierSegment'
      title: List of Shield Information Barrier Segments
      x-box-resource-id: shield_information_barrier_segments
      x-box-tag: shield_information_barrier_segments
    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)