List shield information barrier segment members

get

https://api.box.com/2.0

/shield_information_barrier_segment_members

Lists shield information barrier segment members based on provided segment IDs.

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Query Parameters

limit integer (int64)in queryoptional

example1000max1000

The maximum number of items to return per page.

marker stringin queryoptional

exampleJV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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.

shield_information_barrier_segment_id stringin queryrequired

example3423

The ID of the shield information barrier segment.

Response

200application/jsonList of Shield Information Barrier Segment Members

Returns a paginated list of shield information barrier segment member objects.

defaultapplication/jsonClient error

An unexpected client error.

get

List shield information barrier segment members

You can now try out some of our APIs live, right here in the documentation.

Request Example

TypeScript Gen

await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembers(
  {
    shieldInformationBarrierSegmentId: segment.id!,
  } satisfies GetShieldInformationBarrierSegmentMembersQueryParams,
);

Python Gen

client.shield_information_barrier_segment_members.get_shield_information_barrier_segment_members(
    segment.id
)

.NET Gen

await client.ShieldInformationBarrierSegmentMembers.GetShieldInformationBarrierSegmentMembersAsync(queryParams: new GetShieldInformationBarrierSegmentMembersQueryParams(shieldInformationBarrierSegmentId: NullableUtils.Unwrap(segment.Id)));

Swift Gen (Beta)

try await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembers(queryParams: GetShieldInformationBarrierSegmentMembersQueryParams(shieldInformationBarrierSegmentId: segment.id!))

Node

const result = await client.shieldInformationBarrierSegmentMembers.getAll({
	shield_information_barrier_segment_id: '123'
});
console.log(`There are ${result.entries.length} shield information barrier segment members`);

Response Example

{
  "entries": [
    {
      "id": "11446498",
      "type": "shield_information_barrier_segment_member",
      "user": {
        "id": "11446498",
        "type": "user"
      },
      "shield_information_barrier": {
        "id": "11446498",
        "type": "shield_information_barrier"
      },
      "shield_information_barrier_segment": {
        "id": "432554",
        "type": "shield_information_barrier_segment"
      },
      "created_at": "2020-06-26T18:44:45.869Z",
      "created_by": {
        "id": "11446498",
        "type": "user"
      },
      "updated_at": "2020-07-26T18:44:45.869Z",
      "updated_by": {
        "id": "11446498",
        "type": "user"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}