/v1/organizations/{organizationId}/services/{serviceId}/jwtProviders/{jwtProviderName}This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.
Replaces the configuration of a JWT authentication provider. The JWKS URL is fetched and validated before the change is saved.
Errors:
- 400: invalid provider name or field values, or the JWKS URL is unreachable or does not return a key set with a supported signing key.
- 401: missing, invalid, or disabled API key.
- 403: caller lacks
control-plane:service:manageon the service, or the organization does not have the JWT authentication providers feature (Enterprise tier). - 404: service does not exist, is not visible to the caller, or has no provider with this name.
Permission
The API key must have the control-plane:service:manage permission.
Path parameters
Request bodyJSON
- jwksUrlstringrequired
Public
https://URL of the JSON Web Key Set used to verify token signatures, at most 256 characters. The key set must contain at least one supported signing key: RS256 (RSA), or on ClickHouse 26.8 and later also ES256, ES384 or ES512 (EC); it is fetched and validated when the provider is created or updated.maxLength: 256Example: "https://auth.example.com/.well-known/jwks.json" - rolesClaimoptionalstring
Name of the token claim that lists the ClickHouse roles to grant the user. Printable ASCII without whitespace, at most 256 characters, and not a registered JWT claim (
iss,sub,aud,exp,nbf,iat,jti). The request replaces the whole provider configuration, so omitting this field removes an existing roles claim.Example: "clickhouse:roles"
Response
200
Successful response
400
The request cannot be processed due to a client error. Please verify your request parameters and try again.
500
An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.