Box Developer Documentation
Log in
Latest version

Create shield information barrier

post
https://api.box.com/2.0
/shield_information_barriers

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Creates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them.

Request

bearer [ACCESS_TOKEN]
application/json

Request Body

Enterprise (Base) objectin body

The type and id of enterprise this barrier is under.

Response

application/jsonShield information barrier

Returns a new shield information barrier object.

application/jsonClient error

Returns an error if the enterprise was not found.

application/jsonClient error

An unexpected client error.

post
Create shield information barrier
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versionig strategy.


Node/TypeScript v10
await client.shieldInformationBarriers.createShieldInformationBarrier({
  enterprise: { id: enterpriseId } satisfies EnterpriseBase,
} satisfies CreateShieldInformationBarrierRequestBody);
Python v10
client.shield_information_barriers.create_shield_information_barrier(
    EnterpriseBase(id=enterprise_id)
)
.NET v10
await client.ShieldInformationBarriers.CreateShieldInformationBarrierAsync(requestBody: new CreateShieldInformationBarrierRequestBody(enterprise: new EnterpriseBase() { Id = enterpriseId }));
Swift v10
try await client.shieldInformationBarriers.createShieldInformationBarrier(requestBody: CreateShieldInformationBarrierRequestBody(enterprise: EnterpriseBase(id: enterpriseId)))
Java v10
client.getShieldInformationBarriers().createShieldInformationBarrier(new CreateShieldInformationBarrierRequestBody(new EnterpriseBase.Builder().id(enterpriseId).build()))
Node v3
const barrier = await client.shieldInformationBarriers.create({
    enterprise: {
        id: '12345',
        type: 'enterprise',
    },
});
console.log(
    `Shield information barrier id ${barrier.id} created`
);

Response Example

{
  "id": "11446498",
  "type": "shield_information_barrier",
  "created_at": "2020-06-26T18:44:45.869Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "enabled_at": "2020-07-26T18:44:45.869Z",
  "enabled_by": {
    "id": "11446498",
    "type": "user"
  },
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  },
  "status": "draft",
  "updated_at": "2020-07-26T18:44:45.869Z",
  "updated_by": {
    "id": "11446498",
    "type": "user"
  }
}