OIDC SSO

Changed on

Update OIDC config

patch/api/v1/sso/oidc/config

Request

  • Base URL
    https://us.infisical.com
  • URL
    https://us.infisical.com/api/v1/sso/oidc/config
  • Auth
    HTTP bearer

Request body

allowedEmailDomainsstring

A list of allowed email domains that users can use to authenticate with. This field is comma separated. Supports wildcards (e.g. *.example.com). Example: 'example.com, *.acme.com'

discoveryURLstring

The URL of the OIDC discovery endpoint.

configurationType'custom' | 'discoveryURL'

The configuration type to use for the OIDC configuration.

issuerstring

The issuer for the OIDC configuration. This is only supported when the OIDC configuration type is set to 'custom'.

authorizationEndpointstring

The endpoint to use for OIDC authorization. This is only supported when the OIDC configuration type is set to 'custom'.

jwksUristring

The URL of the OIDC JWKS endpoint.

tokenEndpointstring

The token endpoint to use for OIDC token exchange.

userinfoEndpointstring

The userinfo endpoint to get user information from the OIDC provider.

clientIdstring

The client ID to use for OIDC authentication.

clientSecretstring

The client secret to use for OIDC authentication.

isActiveboolean

Whether to enable or disable this OIDC configuration.

manageGroupMembershipsboolean

Whether to manage group memberships for the OIDC configuration. If enabled, users will automatically be assigned groups when they sign in, based on which groups they are a member of in the OIDC provider.

jwtSignatureAlgorithm'RS256' | 'HS256' | 'RS512' | 'EdDSA'

The algorithm to use for JWT signature verification.

organizationIdstring required

The ID of the organization to update the OIDC config for.

Response

Default Response

idstring uuid required
issuerstring nullable
authorizationEndpointstring nullable
configurationTypestring required
discoveryURLstring nullable
jwksUristring nullable
tokenEndpointstring nullable
userinfoEndpointstring nullable
orgIdstring uuid required
allowedEmailDomainsstring nullable
isActiveboolean required
manageGroupMembershipsboolean

Changes