Skip to content
← Open Cap Table Protocol Canton Node SDK

Reference

ledger.deleteUser

DELETE /v2/users/{user-id} — remove a ledger user by id.

Calls DELETE /v2/users/{userId}.

Receiver: await canton.ledger.deleteUser

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.deleteUser({ userId: 'alice' });

Parameters — DeleteUserParams

  • userId (required string)

Returns — DeleteUserResponse

Deletion acknowledgement JSON.

Auth and party

Admin-scope bearer token.

Source

operations/v2/users/delete-user.ts