Skip to content

Reference

ledger.grantUserRights

POST /v2/users/{user-id}/rights — grant rights; SDK injects identityProviderId empty string in JSON body.

Calls POST /v2/users/{userId}/rights. GrantUserRightsParams merges rights unions (value-wrapped kinds vs REST createUser shapes — consult GrantUserRightsParamsSchema). identityProviderId: '' always appended (grant-user-rights.ts).

Receiver: await canton.ledger.grantUserRights

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.grantUserRights({
  userId: 'alice',
  rights: [],
});

Parameters — GrantUserRightsParams

userId, optional rights array ( GrantUserRightsParamsSchema union families CanActAs.value …).

Returns — GrantUserRightsResponse

Acknowledgement / resulting rights snapshot per Canton OpenAPI.

Auth and party

Admin bearer granting rights subset permissible Canton validates server-side.

Source

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