List shield information barriers

get

https://api.box.com/2.0

/shield_information_barriers

Retrieves a list of shield information barrier objects for the enterprise of JWT.

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.

Response

200application/jsonList of Shield Information Barriers

Returns a paginated list of shield information barrier objects, empty list if currently no barrier.

404application/jsonClient error

Returns a not_found error if could not find an enterprise using JWT.

defaultapplication/jsonClient error

An unexpected client error.

get

List shield information barriers

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

Request Example

TypeScript Gen

await client.shieldInformationBarriers.getShieldInformationBarriers();

Python Gen

client.shield_information_barriers.get_shield_information_barriers()

.NET Gen

await client.ShieldInformationBarriers.GetShieldInformationBarriersAsync();

Swift Gen (Beta)

try await client.shieldInformationBarriers.getShieldInformationBarriers()

Node

const result = await client.shieldInformationBarriers.getAll();
console.log(`There are ${result.entries.length} shield information barriers`);

Response Example

{
  "entries": [
    {
      "id": "11446498",
      "type": "shield_information_barrier",
      "enterprise": {
        "id": "1910967",
        "type": "enterprise"
      },
      "status": "draft",
      "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"
      },
      "enabled_at": "2020-07-26T18:44:45.869Z",
      "enabled_by": {
        "id": "11446498",
        "type": "user"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}