Auth Settings

Get Auth Settings

Changed on

Returns authentication configuration, which determines how users can log in and how they are assigned to teams.

get/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

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

  • 68d43091b84dRevision changes
    • warning

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

  • f324fb7610e4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status