Skip to content

Reference

ledger.deleteIdentityProviderConfig

DELETE /v2/idps/{idpId} — remove an identity provider configuration.

Removes the identity provider configuration keyed by idpId.

Receiver: await canton.ledger.deleteIdentityProviderConfig

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.deleteIdentityProviderConfig({ idpId: 'my-idp' });

Parameters — DeleteIdentityProviderConfigParams

  • idpId (required, string) — Identity provider identifier path segment.

Returns — DeleteIdentityProviderConfigResponse

SDK/OpenAPI payload acknowledging deletion.

Errors and pitfalls

Deleting active providers can strand users—coordinate migrations via updateIdentityProviderConfig first.

Auth and party

Requires participant identity-provider admin privileges available to your token.

See also

Source

operations/v2/idps/delete-idp.ts