Auth Settings

Update Auth Settings

Changed on

Updates authentication configuration.

patch/v3/authentication-settings

Request

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

Request body

basic_auth_enabledboolean

The organization has basic auth enabled.

oidc_auth_enabledboolean

The organization has OIDC disabled.

saml_auth_enabledboolean

The organization has SAML disabled.

idp_mapping_enabledboolean

Whether IdP groups determine the Konnect teams a user has.

konnect_mapping_enabledboolean

Whether a Konnect Identity Admin assigns teams to a user.

Example request

{
  "basic_auth_enabled": true,
  "idp_mapping_enabled": true
}

Response

Response for authentication settings endpoint

basic_auth_enabledboolean

The organization has basic auth enabled.

oidc_auth_enabledboolean

The organization has OIDC disabled.

saml_auth_enabledboolean

The organization has SAML disabled.

idp_mapping_enabledboolean

IdP groups determine the Konnect teams a user has.

konnect_mapping_enabledboolean

A Konnect Identity Admin assigns teams to a user.

Example response

{
  "basic_auth_enabled": true,
  "idp_mapping_enabled": true
}

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