Skip to navigation

Update an identity integration

Updates name/provider/status, replaces the descriptor (re-validated), and/or rotates credentials (per-field: string sets, null clears, absent keeps).

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Identity integration id (idint_…)

Request

This endpoint expects an object.
credentialsobjectOptional

Provider management/client credentials. Sealed at rest, bound to this integration, and never returned by any endpoint. Set a field to rotate it; null clears it.

descriptormap from strings to anyOptional

The IdentityAdapterDescriptor (without id — the server mints it). Validated against the shared identityAdapterDescriptorSchema: discriminated by ‘kind’ (‘oidc-jwt’ | ‘session’ | ‘custom’); verifiable kinds require https issuer/jwksUri, a non-wildcard audience, and asymmetric-only allowedAlgorithms; maxAssurance may only lower the kind ceiling (‘oidc-jwt’ → ‘verified’, others → ‘asserted’).

namestringOptional1-255 characters
providerenumOptional
statusenumOptional
Allowed values:

Response

Identity integration updated
configuredCredentialslist of enums
Allowed values:
createdAtstring
descriptormap from strings to any
idstring
issuerstring or null
kindenum
Allowed values:
namestring
providerstring
statusenum
Allowed values:
updatedAtstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error