Skip to content

Reference

ledger.interactiveSubmissionCreateUser

POST /v2/interactive-submission/create-user — bootstrap ledger users interactively.

Creates InteractiveSubmissionCreateUserParams payloads (user descriptor plus optional rights unions CanActAs, CanReadAs, admin shortcuts).

Receiver: await canton.ledger.interactiveSubmissionCreateUser

Setup

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

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

Minimal example

const created = await canton.ledger.interactiveSubmissionCreateUser({
  user: {
    id: 'alice-interactive',
    primaryParty: canton.getPartyId(),
    isDeactivated: false,
    identityProviderId: 'default',
  },
});

Parameters — InteractiveSubmissionCreateUserParams

Matches InteractiveSubmissionCreateUserParamsSchema (nested user, optional rights union entries).

Returns — InteractiveSubmissionCreateUserResponse

Echo of user plus Canton bookkeeping fields.

Errors and pitfalls

Duplicate user.id yields rejection identical to REST createUser semantics—coordinate migrations accordingly.

Auth and party

Requires privileges permitting interactive submission creation flows enabled by Canton topology.

See also

Source

operations/v2/interactive-submission/create-user.ts