---
title: "Update Identity Provider"
method: PATCH
path: "/v3/identity-providers/{id}"
tags: ["Auth Settings"]
---

# Update Identity Provider

`PATCH /v3/identity-providers/{id}`

Updates the configuration of an existing identity provider. This operation allows modifications to be made 
to an existing identity provider's configuration.

## Request body

- UpdateIdentityProvider — The identity provider that contains configuration data for updating an authentication integration.
  - `enabled` boolean — Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.
  - `login_path` string — The path used for initiating login requests with the identity provider.
  - `config` union
    - object — The identity provider that contains configuration data for the OIDC authentication integration.
      - `issuer_url` string, uri, required — The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.
      - `client_id` string, required — The client ID assigned to your application by the identity provider.
      - `client_secret` string — The Client Secret assigned to your application by the identity provider.
      - `scopes` string[] — The scopes requested by your application when authenticating with the identity provider.
      - `claim_mappings` OIDCIdentityProviderClaimMappings — Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
        - `name` string — The claim mapping for the user's name.
        - `email` string — The claim mapping for the user's email address.
        - `groups` string — The claim mapping for the user's group membership information.
    - object — The identity provider that contains configuration data for the SAML authentication integration.
      - `idp_metadata_url` string, uri — The identity provider's metadata URL where the identity provider's metadata can be obtained.
      - `idp_metadata_xml` string — The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the `idp_metadata_url` field instead.
      - `sp_metadata_url` string, path
      - `sp_entity_id` string — The entity ID of the service provider (SP).
      - `login_url` string — The URL to redirect users to for initiating login with the identity provider.
      - `callback_url` string, path — The path URL where the SAML identity provider sends authentication responses after successful login attempts.

## Response `200`

An identity provider configuration. This response represents the configuration of a specific identity provider, which can be either OIDC or SAML.

- IdentityProvider — The identity provider that contains configuration data for authentication integration.
  - `id` string, uuid — Contains a unique identifier used for this resource.
  - `type` 'oidc' | 'saml' — Specifies the type of identity provider.
  - `enabled` boolean — Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.
  - `login_path` string — The path used for initiating login requests with the identity provider.
  - `config` union
    - object — The identity provider that contains configuration data for the OIDC authentication integration.
      - `issuer_url` string, uri, required — The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.
      - `client_id` string, required — The client ID assigned to your application by the identity provider.
      - `scopes` string[] — The scopes requested by your application when authenticating with the identity provider.
      - `claim_mappings` OIDCIdentityProviderClaimMappings — Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
        - `name` string — The claim mapping for the user's name.
        - `email` string — The claim mapping for the user's email address.
        - `groups` string — The claim mapping for the user's group membership information.
    - object — The identity provider that contains configuration data for the SAML authentication integration.
      - `idp_metadata_url` string, uri — The identity provider's metadata URL where the identity provider's metadata can be obtained.
      - `idp_metadata_xml` string — The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the `idp_metadata_url` field instead.
      - `sp_metadata_url` string, path
      - `sp_entity_id` string — The entity ID of the service provider (SP).
      - `login_url` string — The URL to redirect users to for initiating login with the identity provider.
      - `callback_url` string, path — The path URL where the SAML identity provider sends authentication responses after successful login attempts.
  - `created_at` string, date-time — An ISO-8601 timestamp representation of entity creation date.
  - `updated_at` string, date-time — An ISO-8601 timestamp representation of entity update date.

## Other responses

- `400` — Bad Request
- `401` — Unauthenticated
- `403` — Permission denied
- `404` — Not Found
- `409` — Conflict

## Changes

- **2025-10-23** `8ab3ec3ed301` — 1 warning
  - added the new `type` enum value to the `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterStandard]/rule` response property for the response status `400`
- **2025-08-22** `3c0154b2053a` — 5 breaking, 6 info
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterChoiceItem]/source` became nullable for the status `400`
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterDependentItem]/source` became nullable for the status `400`
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterMaximumLength]/source` became nullable for the status `400`
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterMinimumLength]/source` became nullable for the status `400`
  - …7 more
- **2025-08-14** `6333a0d3b095` — 6 info
  - the `email` request property default value `email` was removed
  - the `groups` request property default value `groups` was removed
  - the `name` request property default value `name` was removed
  - the `email` response's property default value `email` was removed for the status `200`
  - …2 more
- …earlier changes not shown

[Full history](https://skmtc.dev/kong/apis/konnect-api-go-sdk/changes/v3/identity-providers/:id/patch.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.dev/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc.dev/kong/apis/konnect-api-go-sdk/revisions/ab25dca3c161?raw)