Auth Settings

Update IdP Configuration

Changed on

Update the IdP configuration.

patch/v3/identity-provider

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/identity-provider
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

issuerstring uri
login_pathstring
client_idstring
client_secretstring
scopesstring[]

Example request

{
  "issuer": "https://myidp.com/oauth2",
  "login_path": "myapp",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "claim_mappings": {
    "name": "name",
    "email": "email",
    "groups": "custom-group-claim"
  }
}

Response

A get action response of the IdP configuration.

issuerstring uri
login_pathstring
client_idstring
scopesstring[]

Example response

{
  "issuer": "https://myidp.com/oauth2",
  "login_path": "myapp",
  "client_id": "YOUR_CLIENT_ID",
  "claim_mappings": {
    "name": "name",
    "email": "email",
    "groups": "custom-groups-claim"
  }
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 401.00 enum value to the response property for the response status