Skip to content

Reference

ledger.revokeUserRights

PATCH /v2/users/{user-id}/rights — revoke rights; SDK strips path userId from body and injects identityProviderId empty string.

Calls PATCH /v2/users/{userId}/rights. Params RevokeUserRightsParams include userId plus rights unions (value wrappers). Request body omits userId; identityProviderId: '' appended (revoke-user-rights.ts).

Receiver: await canton.ledger.revokeUserRights

Setup

import { Canton } from '@fairmint/canton-node-sdk';

const canton = new Canton({
  network: 'devnet',
  provider: '5n',
  partyId: 'OWN_PARTY_ID',
});

Minimal example

await canton.ledger.revokeUserRights({
  userId: 'alice',
  rights: [],
});

Parameters — RevokeUserRightsParams

Path userId plus rights aligned RevokeUserRightsParamsSchema.

Returns — RevokeUserRightsResponse

Acknowledgement / residual rights snapshot per Canton OpenAPI.

Auth and party

Admin bearer revoking rights permitted Canton validates server-side.

Source

operations/v2/users/revoke-user-rights.ts