Skip to content

Reference

ledger.updateIdentityProviderConfig

PATCH /v2/idps/{identityProviderId} — merge-update identity provider metadata with field mask.

Patches identityProviderConfig objects addressed by identityProviderConfig.identityProviderId with protobuf-style updateMask.paths arrays describing mutable columns (issuer, jwksUrl, audience, isDeactivated, …).

Receiver: await canton.ledger.updateIdentityProviderConfig

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.updateIdentityProviderConfig({
  identityProviderConfig: {
    identityProviderId: 'default',
    isDeactivated: false,
    issuer: 'https://issuer.example',
    jwksUrl: 'https://issuer.example/jwks',
  },
  updateMask: { paths: ['jwksUrl'] },
});

Parameters — UpdateIdentityProviderConfigParams

  • identityProviderConfig (required) — Full provider shape (identityProviderId, booleans, issuer URLs).
  • updateMask (required){ paths: string[] } controlling partial updates.

Returns — UpdateIdentityProviderConfigResponse

Updated provider representation.

Errors and pitfalls

Concurrent edits rely on Canton semantics—watch 409/412-style conflicts depending on deployment.

Auth and party

Identity-provider admin privileges required.

See also

Source

operations/v2/idps/patch-idp.ts