Skip to content
← Open Cap Table Protocol Canton Node SDK

Reference

ledger.updateUser

PATCH /v2/users/{user-id} — patch ledger user metadata via protobuf-style updateMask.

Calls PATCH /v2/users/{userId}. UpdateUserParams: user (id, primaryParty, isDeactivated, metadata) plus updateMask.paths. Body omits userId path duplication (update-user.ts).

Receiver: await canton.ledger.updateUser

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.updateUser({
  userId: 'alice',
  user: {
    id: 'alice',
    isDeactivated: false,
  },
  updateMask: { paths: ['is_deactivated'] },
});

Parameters — UpdateUserParams

See UpdateUserParamsSchema (schemas/operations/users.ts).

Returns — UpdateUserResponse

Updated User record JSON envelope Canton codegen emits.

Auth and party

Admin bearer updating userId identities—coordinate Canton etag concurrency (metadata.resourceVersion) deployments enforcing optimistic concurrency.

Source

operations/v2/users/update-user.ts