Skip to main content
PUT
Update identity provider

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

alias
string
required

The identity provider's alias.

Body

application/json

Request to update an identity provider.

display_name
string | null

New display name.

enabled
boolean | null

Enable or disable the IdP.

oidc_config
OidcConfig · object | null

New OIDC config. Applies only to an OIDC broker.

saml_config
SamlConfig · object | null

New SAML config. Applies only to a SAML broker.

ldap_config
LdapConfig · object | null

New LDAP config. Applies only to an LDAP federation.

mappers
IdpMapperConfig · object[] | null

Replaces all mappers.

Response

Identity provider updated.

Response for a single identity provider.

alias
string
required

Unique alias for the identity provider.

display_name
string
required

Human-readable display name. Falls back to the alias if Keycloak has none set.

provider_id
string
required

Keycloak's own provider identifier, such as oidc, saml, ldap, google, github, or microsoft.

enabled
boolean
required

Whether the IdP is active.

internal_id
string | null

Keycloak's internal UUID for the IdP.

known_provider
enum<string> | null

Preset NexusOne detected from the IdP's provider ID.

Available options:
okta,
entra_id,
auth0,
google,
github,
ping_identity,
onelogin,
custom_oidc,
custom_saml,
active_directory
config
Config · object

Provider configuration. NexusOne masks the secrets.

mapper_count
integer
default:0

Number of configured mappers.