Auth Server Trusted IdPs

Update an auth server trusted IdP

Changed on

Replace a trusted IdP for a given auth server. The request body is the full representation; omitted optional fields are reset to their defaults.

put/v1/auth-servers/{authServerId}/trusted-idps/{authServerTrustedIdpId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/auth-servers/{authServerId}/trusted-idps/{authServerTrustedIdpId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

issuer_urlstring uri required

The issuer URL of the trusted IdP. Unique per auth server.

jwks_uristring uri

JWKS URI of the trusted IdP. Overrides OIDC discovery when set.

directory_idstring uuid required

The Kong Identity directory used for principal lookup and provisioning.

id_jag_enabledboolean

Whether ID-JAG (jwt-bearer) token exchange is enabled.

jit_provisioning_enabledboolean

Whether principals are provisioned just-in-time on first exchange. Defaults to true; set false to opt out.

Example request

{
  "issuer_url": "https://acme.okta.com/oauth2/default"
}

Response

A trusted IdP

idstring uuid required

The ID of the trusted IdP.

auth_server_idstring uuid required

The auth server this trusted IdP belongs to.

issuer_urlstring uri required

The issuer URL of the trusted IdP. Unique per auth server.

jwks_uristring uri

JWKS URI of the trusted IdP. Overrides OIDC discovery when set.

directory_idstring uuid required

The Kong Identity directory used for principal lookup and provisioning.

id_jag_enabledboolean required

Whether ID-JAG (jwt-bearer) token exchange is enabled.

jit_provisioning_enabledboolean required

Whether principals are provisioned just-in-time on first exchange.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "issuer_url": "https://acme.okta.com/oauth2/default",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes