Portal Auth Settings

Update Auth Settings

Changed on

Updates the developer authentication configuration for a portal. Developers can be allowed to login using basic auth (email & password) or use Single-Sign-On through an Identity Provider. Developers can be automatically assigned to teams by mapping claims from their IdP account.

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

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/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

Deprecated. Use the Identity Provider API instead.

saml_auth_enabledboolean

Deprecated. Use the Identity Provider API instead.

oidc_team_mapping_enabledboolean

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

konnect_mapping_enabledboolean

Whether a Konnect Identity Admin assigns teams to a developer.

idp_mapping_enabledboolean

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

oidc_issuerstring nullable

Deprecated. Use the Identity Provider API instead.

oidc_client_idstring nullable

Deprecated. Use the Identity Provider API instead.

oidc_client_secretstring nullable

Deprecated. Use the Identity Provider API instead.

oidc_scopesstring[] nullable

Deprecated. Use the Identity Provider API instead.

Example request

{
  "basic_auth_enabled": true,
  "oidc_auth_enabled": true,
  "oidc_team_mapping_enabled": true,
  "konnect_mapping_enabled": false,
  "oidc_issuer": "https://identity.example.com/v2",
  "oidc_client_id": "x7id0o42lklas0blidl2",
  "oidc_scopes": [
    "email",
    "openid",
    "profile"
  ],
  "oidc_claim_mappings": {
    "name": "name",
    "email": "email",
    "groups": "custom-group-claim"
  }
}

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

  • 106b373707f3Revision 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

  • 0325d14dfc53Revision changes
    • breaking

      the response property became nullable for the status

    • info

      the request property became nullable

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      response property oidc_auth_enabled deprecated

    • info

      response property oidc_config deprecated

    • info

      response property oidc_team_mapping_enabled deprecated

    • info

      response property saml_auth_enabled deprecated