Updates the OpenID Connect federation configuration.

put https://{tenanturl}/v1.0/oidc/federation

Modify federation settings for this tenant.

Entitlements required: manageFederations (Manage federations)

Body Params

Federation settings

issuerHostname

string

required

Host name used for the JWT issuer. It must be the tenant host name or one of the vanity host names. The full issuer string will be https://{issuerHostname}/oidc/endpoint/default

idTokenLifetime

object

required

deviceFlowPollingInterval

object

deviceFlowCodeLifetime

object

extraMetadataAttributes

object

Top level attributes for well-known endpoint to override the existing attribute.

excludeJWKSCertificateChain

boolean

Setting to exclude 'x5c' in JWKS.

excludeJWKSCertificateThumbprint

boolean

Setting to exclude 'x5t' and 'x5t#S256' in JWKS.

mtlsEndpointBaseURI

string

Base URL for MTLS endpoints. This must include the protocol scheme like https.

defaultSigningKey

string

Default signing key for JWT.

defaultEncryptionKey

string

Default encryption key for JWT.

refreshTokenFaultToleranceLifetime

object

tokenExchangeIdTokenToleranceWindow

object

Responses

204

The federation configuration was updated.

403

Access was forbidden.

Language

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://tenant_url/v1.0/oidc/federation \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

*/*

400The request was invalid.

409Conflicting modifications. Try again later.

500An internal server error occurred.