v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB

Auth Settings

Update Identity Provider

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

patch/v3/identity-providers/{id}

Request body

enabledboolean

Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.

login_pathstring

The path used for initiating login requests with the identity provider.

Example request

{
  "enabled": true,
  "login_path": "myapp",
  "config": {
    "issuer_url": "https://konghq.okta.com/oauth2/default",
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "claim_mappings": {
      "name": "name",
      "email": "email",
      "groups": "groups"
    }
  }
}

Response

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

idstring uuid

Contains a unique identifier used for this resource.

type'oidc' | 'saml'

Specifies the type of identity provider.

enabledboolean

Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.

login_pathstring

The path used for initiating login requests with the identity provider.

created_atstring date-time

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "type": "oidc",
  "enabled": true,
  "login_path": "myapp",
  "config": {
    "issuer_url": "https://konghq.okta.com/oauth2/default",
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "claim_mappings": {
      "name": "name",
      "email": "email",
      "groups": "groups"
    }
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}