Skip to content
← Open Cap Table Protocol Canton Node SDK

Reference

listUsers

Enumerate usernames onboarded onto this validator via the admin users listing endpoint.

listUsers is primarily operational auditing—confirm provisioning pipelines inserted rows correctly before onboarding wallets.

Setup

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

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

Import and receiver

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

Receiver: canton.validator.listUsers.

Minimal example

const { usernames } = await canton.validator.listUsers();
console.log(usernames);

Parameters

None.

Returns

Object containing usernames (string array per SDK examples); richer administrator columns appear depending on Canton version/OpenAPI snapshot.

Errors and pitfalls

  • 403: Forbidden without elevated scopes.

Auth and party

Bearer token authorized on /admin/users.

See also

Source

src/clients/validator-api/operations/v0/admin/list-users.ts on GitHub.