get user

ledger.getUser

Calls GET /v2/users/{userId}. Adds identity-provider-id= (empty string) query parameter unconditionally (operations/v2/users/get-user.ts).

Receiver: await canton.ledger.getUser

Setup

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

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

Minimal example

const u = await canton.ledger.getUser({ userId: 'alice' });

Parameters — GetUserParams

• userId (required string)

Returns — GetUserResponse

Ledger User JSON (schemas/api / OpenAPI).

Auth and party

Caller token must allow viewing userId identities.

Source

operations/v2/users/get-user.ts