Latest version
Create shield information barrier
API version 2024.0
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.
Request Example
TypeScript Gen
await client.shieldInformationBarriers.createShieldInformationBarrier({
enterprise: { id: enterpriseId } satisfies EnterpriseBase,
} satisfies CreateShieldInformationBarrierRequestBody);Python Gen
client.shield_information_barriers.create_shield_information_barrier(
EnterpriseBase(id=enterprise_id)
).NET Gen
await client.ShieldInformationBarriers.CreateShieldInformationBarrierAsync(requestBody: new CreateShieldInformationBarrierRequestBody(enterprise: new EnterpriseBase() { Id = enterpriseId }));Swift Gen (Beta)
try await client.shieldInformationBarriers.createShieldInformationBarrier(requestBody: CreateShieldInformationBarrierRequestBody(enterprise: EnterpriseBase(id: enterpriseId)))Node
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"
}
}