Box

Box Shield Information Barrier Segment Members API

Shield information barrier segment member represents a user that is assigned to a specific segment.

Documentation GitHub OpenAPI

Operations 4

GET /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id} Box Get shield information barrier segment member by ID #

DELETE /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id} Box Delete shield information barrier segment member by ID #

GET /shield_information_barrier_segment_members Box List shield information barrier segment members #

POST /shield_information_barrier_segment_members Box Create shield information barrier segment member #

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-members-api-openapi.yml

Other Resources

https://raw.githubusercontent.com/api-evangelist/box/refs/heads/main/graphql/box-graphql.md

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-members-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 Shield Information Barrier Segment Members API
  x-refined-note:
  - x-box-commit-hash differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Shield Information Barrier Segment Members across 2 of this provider''s published API definitions: box-openapi-original.yml, shield-information-barrier-segment-members-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.box.com/2.0
  description: Box Platform API server
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: Box Get shield information barrier segment member by ID
      tags:
      - Shield Information Barrier Segment Members
      x-box-tag: shield_information_barrier_segment_members
      description: 'Retrieves a shield information barrier

        segment member by its ID.'
      parameters:
      - name: shield_information_barrier_segment_member_id
        description: The ID of the shield information barrier segment Member.
        example: '7815'
        in: path
        required: true
        schema:
          type: string
      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'
      security:
      - OAuth2Security: []
    delete:
      operationId: delete_shield_information_barrier_segment_members_id
      summary: Box Delete shield information barrier segment member by ID
      tags:
      - Shield Information Barrier Segment Members
      x-box-tag: shield_information_barrier_segment_members
      description: 'Deletes a shield information barrier

        segment member based on provided ID.'
      parameters:
      - name: shield_information_barrier_segment_member_id
        description: The ID of the shield information barrier segment Member.
        example: '7815'
        in: path
        required: true
        schema:
          type: string
      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'
      security:
      - OAuth2Security: []
    servers:
    - url: https://api.box.com/2.0
      description: Box Platform API server
  /shield_information_barrier_segment_members:
    get:
      operationId: get_shield_information_barrier_segment_members
      summary: Box List shield information barrier segment members
      tags:
      - Shield Information Barrier Segment Members
      x-box-tag: shield_information_barrier_segment_members
      description: 'Lists shield information barrier segment members

        based on provided segment IDs.'
      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 member objects.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierSegmentMembers'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      security:
      - OAuth2Security: []
    post:
      operationId: post_shield_information_barrier_segment_members
      summary: Box Create shield information barrier segment member
      tags:
      - Shield Information Barrier Segment Members
      x-box-tag: shield_information_barrier_segment_members
      description: Creates a new shield information barrier segment member.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - shield_information_barrier_segment
              - user
              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:
                  type: object
                  properties:
                    id:
                      type: string
                      example: '432554'
                      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.'
                user:
                  allOf:
                  - $ref: '#/components/schemas/User--Base'
                  description: User to which restriction will be applied.
      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'
      security:
      - OAuth2Security: []
    servers:
    - url: https://api.box.com/2.0
      description: Box Platform API server
components:
  schemas:
    ShieldInformationBarrierSegmentMember--Mini:
      title: Shield information barrier segment member (Mini)
      type: object
      x-box-resource-id: shield_information_barrier_segment_member--mini
      x-box-tag: shield_information_barrier_segment_members
      x-box-variants:
      - base
      - mini
      - standard
      x-box-variant: mini
      description: 'A mini representation of a

        shield information barrier segment member 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.
    ShieldInformationBarrierSegmentMember--Base:
      title: Shield information barrier segment member (Base)
      type: object
      x-box-resource-id: shield_information_barrier_segment_member--base
      x-box-tag: shield_information_barrier_segment_members
      x-box-variants:
      - base
      - mini
      - standard
      x-box-variant: base
      description: 'A base representation of a

        shield information barrier segment member object'
      properties:
        id:
          type: string
          example: '11446498'
          description: 'The unique identifier for the

            shield information barrier segment member'
        type:
          type: string
          description: The type of the shield information barrier segment member
          example: shield_information_barrier_segment_member
          enum:
          - shield_information_barrier_segment_member
    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
    ShieldInformationBarrierSegmentMember:
      title: Shield information barrier segment member
      type: object
      x-box-resource-id: shield_information_barrier_segment_member
      x-box-tag: shield_information_barrier_segment_members
      x-box-variants:
      - base
      - mini
      - standard
      x-box-variant: standard
      description: 'A standard representation of a

        shield information barrier segment member object'
      allOf:
      - $ref: '#/components/schemas/ShieldInformationBarrierSegmentMember--Mini'
      - properties:
          shield_information_barrier:
            $ref: '#/components/schemas/ShieldInformationBarrier--Base'
          shield_information_barrier_segment:
            type: object
            properties:
              id:
                type: string
                example: '432554'
                description: 'The ID reference of the requesting

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

              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:
            type: string
            format: date-time
            example: '2020-06-26T18:44:45.869Z'
            description: 'ISO date time string when this shield

              information barrier object was created.'
          created_by:
            allOf:
            - $ref: '#/components/schemas/User--Base'
            - description: The user who created this shield information barrier segment member.
          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 Member was updated.'
          updated_by:
            allOf:
            - $ref: '#/components/schemas/User--Base'
            - description: The user that updated this shield information barrier segment Member.
    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
    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
    ShieldInformationBarrierSegmentMembers:
      title: List of Shield Information Barrier Segment Members
      type: object
      x-box-resource-id: shield_information_barrier_segment_members
      x-box-tag: shield_information_barrier_segment_members
      description: List of Shield Information Barrier Member 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 members'
            items:
              $ref: '#/components/schemas/ShieldInformationBarrierSegmentMember'
    ClientError_2:
      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
          nullable: false
        status:
          description: The HTTP status of the response.
          example: 400
          type: integer
          format: int32
          nullable: false
        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
          nullable: false
        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
          nullable: true
          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
          nullable: false
        request_id:
          description: 'A unique identifier for this response, which can be used

            when contacting Box support.'
          type: string
          example: abcdef123456
          nullable: false
    ShieldInformationBarrierSegmentMembers_2:
      title: List of Shield Information Barrier Segment Members
      type: object
      x-box-resource-id: shield_information_barrier_segment_members
      x-box-tag: shield_information_barrier_segment_members
      description: List of Shield Information Barrier Member 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
            nullable: true
      - properties:
          entries:
            type: array
            description: 'A list of shield information

              barrier segment members'
            items:
              $ref: '#/components/schemas/ShieldInformationBarrierSegmentMember'
  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
x-refined-from:
- box-openapi-original.yml
- shield-information-barrier-segment-members-openapi-original.yml