KOkong
Portal Auth Settings

Get Auth Settings

Changed on

Returns the developer authentication configuration for a portal, which determines how developers can log in and how they are assigned to teams.

get/v3/portals/{portalId}/authentication-settings

Request

  • Base URL
    https://global.api.konghq.com
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP bearer
    • or HTTP bearer

Response

Details about a portal's authentication settings.

basic_auth_enabledboolean required

The portal has basic auth enabled or disabled.

oidc_auth_enabledboolean required

The portal has OIDC enabled or disabled.

saml_auth_enabledboolean

A Konnect Identity Admin assigns teams to a developer.

oidc_team_mapping_enabledboolean required

IdP groups determine the Portal Teams a developer has. Replaced by idp_mapping_enabled.

idp_mapping_enabledboolean

Whether IdP groups determine the Konnect Portal teams a developer has.

konnect_mapping_enabledboolean required

A Konnect Identity Admin assigns teams to a developer.

oidc_issuerstring nullable
oidc_client_idstring nullable
oidc_scopesstring[] nullable

Example response

{
  "basic_auth_enabled": true,
  "oidc_auth_enabled": true,
  "oidc_team_mapping_enabled": true,
  "konnect_mapping_enabled": false,
  "oidc_config": {
    "issuer": "https://identity.example.com/v2",
    "client_id": "x7id0o42lklas0blidl2",
    "scopes": [
      "email",
      "openid",
      "profile"
    ],
    "claim_mappings": {
      "name": "name",
      "email": "email",
      "groups": "custom-group-claim"
    }
  }
}

Changes

  • 4a02153f2e60Revision changes
    • info

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

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • 4b75c54c0f2bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response optional property became read-only for the status