Skip to content

shieldinformationbarriers.md

Latest commit

 

History

History
129 lines (78 loc) · 4 KB

shieldinformationbarriers.md

File metadata and controls

129 lines (78 loc) · 4 KB

ShieldInformationBarriersManager

Get shield information barrier with specified ID

Get shield information barrier based on provided ID.

This operation is performed by calling function getShieldInformationBarrierById.

See the endpoint docs at API Reference.

client.getShieldInformationBarriers().getShieldInformationBarrierById(barrierId)

Arguments

  • shieldInformationBarrierId String
    • The ID of the shield information barrier. Example: "1910967"
  • headers GetShieldInformationBarrierByIdHeaders
    • Headers of getShieldInformationBarrierById method

Returns

This function returns a value of type ShieldInformationBarrier.

Returns the shield information barrier object.

Add changed status of shield information barrier with specified ID

Change status of shield information barrier with the specified ID.

This operation is performed by calling function updateShieldInformationBarrierStatus.

See the endpoint docs at API Reference.

client.getShieldInformationBarriers().updateShieldInformationBarrierStatus(new UpdateShieldInformationBarrierStatusRequestBody(barrierId, UpdateShieldInformationBarrierStatusRequestBodyStatusField.DISABLED))

Arguments

  • requestBody UpdateShieldInformationBarrierStatusRequestBody
    • Request body of updateShieldInformationBarrierStatus method
  • headers UpdateShieldInformationBarrierStatusHeaders
    • Headers of updateShieldInformationBarrierStatus method

Returns

This function returns a value of type ShieldInformationBarrier.

Returns the updated shield information barrier object.

List shield information barriers

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

This operation is performed by calling function getShieldInformationBarriers.

See the endpoint docs at API Reference.

client.getShieldInformationBarriers().getShieldInformationBarriers()

Arguments

  • queryParams GetShieldInformationBarriersQueryParams
    • Query parameters of getShieldInformationBarriers method
  • headers GetShieldInformationBarriersHeaders
    • Headers of getShieldInformationBarriers method

Returns

This function returns a value of type ShieldInformationBarriers.

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

Create shield information barrier

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

This operation is performed by calling function createShieldInformationBarrier.

See the endpoint docs at API Reference.

client.getShieldInformationBarriers().createShieldInformationBarrier(new CreateShieldInformationBarrierRequestBody(new EnterpriseBase.Builder().id(enterpriseId).build()))

Arguments

  • requestBody CreateShieldInformationBarrierRequestBody
    • Request body of createShieldInformationBarrier method
  • headers CreateShieldInformationBarrierHeaders
    • Headers of createShieldInformationBarrier method

Returns

This function returns a value of type ShieldInformationBarrier.

Returns a new shield information barrier object.