Box Shield Information Barrier Segment Members API

openapi: 3.2.0
info:
  title: Box Platform Shield information barrier segment members 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 segment members
  description: Shield information barrier segment member represents a user that is assigned to a specific segment.
  x-box-tag: shield_information_barrier_segment_members
paths:
  /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}:
    get:
      operationId: get_shield_information_barrier_segment_members_id
      summary: Get shield information barrier segment member by ID
      description: Retrieves a shield information barrier segment member by its ID.
      parameters:
      - name: shield_information_barrier_segment_member_id
        in: path
        description: The ID of the shield information barrier segment Member.
        required: true
        schema:
          type: string
        example: '7815'
      responses:
        '200':
          description: Returns the shield information barrier segment member object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierSegmentMember'
        '404':
          description: Returns a `not_found` error if the shield information barrier segment member 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_members
      tags:
      - Shield information barrier segment members
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Get shield information barrier segment member by ID
        source: "curl -i -X GET \"https://api.box.com/2.0/shield_information_barrier_segment_members/7815\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Get shield information barrier segment member by ID
        source: 'await client.ShieldInformationBarrierSegmentMembers.GetShieldInformationBarrierSegmentMemberByIdAsync(shieldInformationBarrierSegmentMemberId: NullableUtils.Unwrap(segmentMember.Id));'
      - lang: swift
        label: Get shield information barrier segment member by ID
        source: 'try await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMemberById(shieldInformationBarrierSegmentMemberId: segmentMember.id!)'
      - lang: java
        label: Get shield information barrier segment member by ID
        source: client.getShieldInformationBarrierSegmentMembers().getShieldInformationBarrierSegmentMemberById(segmentMember.getId())
      - lang: node
        label: Get shield information barrier segment member by ID
        source: "await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMemberById(\n  segmentMember.id!,\n);"
      - lang: python
        label: Get shield information barrier segment member by ID
        source: "client.shield_information_barrier_segment_members.get_shield_information_barrier_segment_member_by_id(\n    segment_member.id\n)"
    delete:
      operationId: delete_shield_information_barrier_segment_members_id
      summary: Delete shield information barrier segment member by ID
      description: Deletes a shield information barrier segment member based on provided ID.
      parameters:
      - name: shield_information_barrier_segment_member_id
        in: path
        description: The ID of the shield information barrier segment Member.
        required: true
        schema:
          type: string
        example: '7815'
      responses:
        '204':
          description: Returns an empty response if the segment member was deleted successfully.
        '404':
          description: Returns a `not_found` error if the shield information barrier segment member 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_members
      tags:
      - Shield information barrier segment members
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Delete shield information barrier segment member by ID
        source: "curl -i -X DELETE \"https://api.box.com/2.0/shield_information_barrier_segment_members/7815\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Delete shield information barrier segment member by ID
        source: 'await client.ShieldInformationBarrierSegmentMembers.DeleteShieldInformationBarrierSegmentMemberByIdAsync(shieldInformationBarrierSegmentMemberId: NullableUtils.Unwrap(segmentMember.Id));'
      - lang: swift
        label: Delete shield information barrier segment member by ID
        source: 'try await client.shieldInformationBarrierSegmentMembers.deleteShieldInformationBarrierSegmentMemberById(shieldInformationBarrierSegmentMemberId: segmentMember.id!)'
      - lang: java
        label: Delete shield information barrier segment member by ID
        source: client.getShieldInformationBarrierSegmentMembers().deleteShieldInformationBarrierSegmentMemberById(segmentMember.getId())
      - lang: node
        label: Delete shield information barrier segment member by ID
        source: "await client.shieldInformationBarrierSegmentMembers.deleteShieldInformationBarrierSegmentMemberById(\n  segmentMember.id!,\n);"
      - lang: python
        label: Delete shield information barrier segment member by ID
        source: "client.shield_information_barrier_segment_members.delete_shield_information_barrier_segment_member_by_id(\n    segment_member.id\n)"
  /shield_information_barrier_segment_members:
    get:
      operationId: get_shield_information_barrier_segment_members
      summary: List shield information barrier segment members
      description: Lists shield information barrier segment members based on provided segment IDs.
      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 member objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierSegmentMembers'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: shield_information_barrier_segment_members
      tags:
      - Shield information barrier segment members
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: List shield information barrier segment members
        source: "curl -i -X GET \"https://api.box.com/2.0/shield_information_barrier_segment_members?shield_information_barrier_segment_id=3423\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: List shield information barrier segment members
        source: 'await client.ShieldInformationBarrierSegmentMembers.GetShieldInformationBarrierSegmentMembersAsync(queryParams: new GetShieldInformationBarrierSegmentMembersQueryParams(shieldInformationBarrierSegmentId: NullableUtils.Unwrap(segment.Id)));'
      - lang: swift
        label: List shield information barrier segment members
        source: 'try await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembers(queryParams: GetShieldInformationBarrierSegmentMembersQueryParams(shieldInformationBarrierSegmentId: segment.id!))'
      - lang: java
        label: List shield information barrier segment members
        source: client.getShieldInformationBarrierSegmentMembers().getShieldInformationBarrierSegmentMembers(new GetShieldInformationBarrierSegmentMembersQueryParams(segment.getId()))
      - lang: node
        label: List shield information barrier segment members
        source: "await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembers(\n  {\n    shieldInformationBarrierSegmentId: segment.id!,\n  } satisfies GetShieldInformationBarrierSegmentMembersQueryParams,\n);"
      - lang: python
        label: List shield information barrier segment members
        source: "client.shield_information_barrier_segment_members.get_shield_information_barrier_segment_members(\n    segment.id\n)"
    post:
      operationId: post_shield_information_barrier_segment_members
      summary: Create shield information barrier segment member
      description: Creates a new shield information barrier segment member.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  description: A type of the shield barrier segment member.
                  type: string
                  example: shield_information_barrier_segment_member
                  enum:
                  - shield_information_barrier_segment_member
                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: '432554'
                    type:
                      description: The type of the shield barrier segment for this member.
                      type: string
                      example: shield_information_barrier_segment
                      enum:
                      - shield_information_barrier_segment
                user:
                  description: User to which restriction will be applied.
                  allOf:
                  - $ref: '#/components/schemas/User--Base'
              required:
              - shield_information_barrier_segment
              - user
      responses:
        '201':
          description: Returns a new shield information barrier segment member object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierSegmentMember'
        '404':
          description: Returns an 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_members
      tags:
      - Shield information barrier segment members
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Create shield information barrier segment member
        source: "curl -i -X POST \"https://api.box.com/2.0/shield_information_barrier_segment_members\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"shield_information_barrier_segment\": {\n         \"id\": \"432554\",\n         \"type\": \"shield_information_barrier_segment\"\n       },\n       \"user\": {\n         \"id\": \"11446498\",\n         \"type\": \"user\"\n       }\n     }'"
      - lang: dotnet
        label: Create shield information barrier segment member
        source: 'await client.ShieldInformationBarrierSegmentMembers.CreateShieldInformationBarrierSegmentMemberAsync(requestBody: new CreateShieldInformationBarrierSegmentMemberRequestBody(shieldInformationBarrierSegment: new CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField() { Id = NullableUtils.Unwrap(segment.Id), Type = CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField.ShieldInformationBarrierSegment }, user: new UserBase(id: Utils.GetEnvVar(name: "USER_ID"))));'
      - lang: swift
        label: Create shield information barrier segment member
        source: 'try await client.shieldInformationBarrierSegmentMembers.createShieldInformationBarrierSegmentMember(requestBody: CreateShieldInformationBarrierSegmentMemberRequestBody(shieldInformationBarrierSegment: CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField(id: segment.id!, type: CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField.shieldInformationBarrierSegment), user: UserBase(id: Utils.getEnvironmentVariable(name: "USER_ID"))))'
      - lang: java
        label: Create shield information barrier segment member
        source: client.getShieldInformationBarrierSegmentMembers().createShieldInformationBarrierSegmentMember(new CreateShieldInformationBarrierSegmentMemberRequestBody(new CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField.Builder().id(segment.getId()).type(CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField.SHIELD_INFORMATION_BARRIER_SEGMENT).build(), new UserBase(getEnvVar("USER_ID"))))
      - lang: node
        label: Create shield information barrier segment member
        source: "await client.shieldInformationBarrierSegmentMembers.createShieldInformationBarrierSegmentMember(\n  {\n    shieldInformationBarrierSegment: {\n      id: segment.id!,\n      type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField,\n    } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField,\n    user: new UserBase({ id: getEnvVar('USER_ID') }),\n  } satisfies CreateShieldInformationBarrierSegmentMemberRequestBody,\n);"
      - lang: python
        label: Create shield information barrier segment member
        source: "client.shield_information_barrier_segment_members.create_shield_information_barrier_segment_member(\n    CreateShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment(\n        id=segment.id,\n        type=CreateShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentTypeField.SHIELD_INFORMATION_BARRIER_SEGMENT,\n    ),\n    UserBase(id=get_env_var(\"USER_ID\")),\n)"
components:
  schemas:
    ShieldInformationBarrierSegmentMember:
      description: A standard representation of a shield information barrier segment member object.
      type: object
      allOf:
      - $ref: '#/components/schemas/ShieldInformationBarrierSegmentMember--Mini'
      - properties:
          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: '432554'
              type:
                description: The type of the shield information barrier segment.
                type: string
                example: shield_information_barrier_segment
                enum:
                - shield_information_barrier_segment
          user:
            allOf:
            - $ref: '#/components/schemas/User--Base'
            - description: The `type` and `id` of the requested shield information barrier segment member.
          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 member.
          updated_at:
            description: ISO date time string when this shield information barrier segment Member 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 Member.
      title: Shield information barrier segment member
      x-box-resource-id: shield_information_barrier_segment_member
      x-box-tag: shield_information_barrier_segment_members
      x-box-variant: standard
      x-box-variants:
      - base
      - mini
      - standard
    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
    ShieldInformationBarrierSegmentMember--Mini:
      description: A mini representation of a shield information barrier segment member object.
      type: object
      allOf:
      - $ref: '#/components/schemas/ShieldInformationBarrierSegmentMember--Base'
      - properties:
          user:
            allOf:
            - $ref: '#/components/schemas/User--Base'
            - description: The `type` and `id` of the requested shield information barrier segment member.
      title: Shield information barrier segment member (Mini)
      x-box-resource-id: shield_information_barrier_segment_member--mini
      x-box-tag: shield_information_barrier_segment_members
      x-box-variant: mini
      x-box-variants:
      - base
      - mini
      - standard
    ShieldInformationBarrierSegmentMembers:
      description: List of Shield Information Barrier Member 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 members.
            type: array
            items:
              $ref: '#/components/schemas/ShieldInformationBarrierSegmentMember'
      title: List of Shield Information Barrier Segment Members
      x-box-resource-id: shield_information_barrier_segment_members
      x-box-tag: shield_information_barrier_segment_members
    ShieldInformationBarrierSegmentMember--Base:
      description: A base representation of a shield information barrier segment member object.
      type: object
      properties:
        id:
          description: The unique identifier for the shield information barrier segment member.
          type: string
          example: '11446498'
        type:
          description: The type of the shield information barrier segment member.
          type: string
          example: shield_information_barrier_segment_member
          enum:
          - shield_information_barrier_segment_member
      title: Shield information barrier segment member (Base)
      x-box-resource-id: shield_information_barrier_segment_member--base
      x-box-tag: shield_information_barrier_segment_members
      x-box-variant: base
      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)