ACLs7

Add-Ons5

AI Gateway Agents5

AI Gateway Auth Strategies5

AI Gateway CA Certificates5

AI Gateway Certificates5

AI Gateway Config Stores10

AI Gateway Consumer Groups8

AI Gateway Consumers11

AI Gateway DataPlane Certificates4

AI Gateway Identity Providers5

AI Gateway MCP Servers5

AI Gateway Model Providers5

AI Gateway Models5

AI Gateway Nodes3

AI Gateway Policies5

AI Gateway SNIs10

AI Gateway Vaults5

AI Gateways6

API6

API Attributes1

API Documentation6

API Image4

API Implementation4

API Operations2

API Package Documentation6

API Package Image4

API Package Operations4

API Package Specification4

API Packages5

API Publication8

API Specification6

API Version5

API-keys7

App Auth Strategies6

Application Registrations8

Applications8

Assets6

Auth Settings17

Authentication1

Basic-auth credentials7

CA Certificates5

Catalog Integrations1

Catalog Resource Mappings4

Catalog Resource Services1

Catalog Resources3

Catalog Service API Mappings5

Catalog Service Resources1

Catalog Services5

Certificates5

Cloud Gateways Resource Quotas3

Config Store Secrets5

Config Stores5

Consumer Groups9

Consumers9

Control Plane Groups6

Control Planes5

Criteria Templates1

Custom Domains5

Custom Plugin Schemas5

CustomPlugins5

Dashboards5

Data-Plane Group Configurations3

DCR Providers6

Degraphql_routes7

DP Certificates5

DP Nodes6

Event Gateway Backend Clusters5

Event Gateway DataPlane Certificates5

Event Gateway Listener Policies9

Event Gateway Listeners5

Event Gateway Nodes4

Event Gateway Schema Registries5

Event Gateway Static Keys4

Event Gateway TLS Trust Bundles5

Event Gateway Virtual Cluster Consume Policies9

Event Gateway Virtual Cluster Policies9

Event Gateway Virtual Cluster Produce Policies9

Event Gateway Virtual Clusters5

Event Gateways6

GraphQL Cost Decorations7

HMAC-auth credentials7

Impersonation Settings2

Integration Instance Auth Config3

Integration Instance Auth Credentials3

Integration Instances5

Invites1

JWTs7

Keys10

KeySets5

MCP Server Runtime1

MCP Servers6

Me2

Metering Events2

Meters6

MTLS-auth credentials7

Networks6

Notifications11

OpenMeter Apps2

OpenMeter Billing Settings5

OpenMeter Customers19

OpenMeter Defaults2

OpenMeter Entitlements1

OpenMeter Features6

OpenMeter LLM Cost5

OpenMeter Product Catalog19

OpenMeter Subscriptions8

OpenMeter Tax5

Pages7

Partial Links1

Partials5

Personal Access Tokens6

Plugins26

Portal Audit Logs6

Portal Auth Settings13

Portal Custom Domains4

Portal Customization3

Portal Developers5

Portal Emails19

Portal Integrations3

Portal Team Membership4

Portal Team Roles4

Portal Teams5

Portals5

Portals IP Allow List6

Private DNS5

Provider Accounts2

Resource Availability1

Resource Configurations3

Roles9

Routes10

Schemas2

Scorecards11

Services5

Skills2

Snippets5

SNIs10

System Accounts5

System Accounts - Access Tokens5

System Accounts - Roles4

System Accounts - Team Membership4

Targets6

Team Membership4

Teams5

Transit Gateways5

Upstreams5

Users4

Vaults5

Portal Auth Settings

Update Auth Settings

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

Deprecated. Use the Identity Provider API instead.

oidc_client_idstring

Deprecated. Use the Identity Provider API instead.

oidc_client_secretstring

Deprecated. Use the Identity Provider API instead.

oidc_scopesstring[]

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.

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

Changed in 8 of the 75 revisions of this API.20153

Jan 29, 20260c2eede222681See the full diff
- ○
  the response optional property became read-only for the status
  response-optional-property-became-read-only
Dec 3, 2025581456e3279f12See the full diff
- ○
  request property deprecated
  request-property-deprecated
- ○
  request property deprecated
  request-property-deprecated
- ○
  request property deprecated
  request-property-deprecated
- ○
  request property deprecated
  request-property-deprecated
- ○
  request property deprecated
  request-property-deprecated
- ○
  request property deprecated
  request-property-deprecated
- ○
  request property deprecated
  request-property-deprecated
- ○
  request property deprecated
  request-property-deprecated
- ○
  response property oidc_auth_enabled deprecated
  response-property-deprecated
- ○
  response property oidc_config deprecated
  response-property-deprecated
- ○
  response property oidc_team_mapping_enabled deprecated
  response-property-deprecated
- ○
  response property saml_auth_enabled deprecated
  response-property-deprecated
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 30, 2025845120e19d459See the full diff
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
Oct 23, 20258ab3ec3ed3011See the full diff
- ●
  added the new type enum value to the /////// response property for the response status
  response-property-enum-value-added
Aug 22, 20253c0154b2053a1119See the full diff
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property default value openid was added
  request-property-default-value-added
- ○
  the request property default value email was added
  request-property-default-value-added
- ○
  the request property default value groups was added
  request-property-default-value-added
- ○
  the request property default value name was added
  request-property-default-value-added
- ○
  the request property default value email openid profile was added
  request-property-default-value-added
- ○
  the response's property default value openid was added for the status
  response-property-default-value-added
- ○
  the response's property default value email was added for the status
  response-property-default-value-added
- ○
  the response's property default value groups was added for the status
  response-property-default-value-added
- ○
  the response's property default value name was added for the status
  response-property-default-value-added
- ○
  the response's property default value email openid profile was added for the status
  response-property-default-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 14, 20256333a0d3b09510See the full diff
- ○
  the request property default value openid was removed
  request-property-default-value-removed
- ○
  the request property default value email was removed
  request-property-default-value-removed
- ○
  the request property default value groups was removed
  request-property-default-value-removed
- ○
  the request property default value name was removed
  request-property-default-value-removed
- ○
  the request property default value email openid profile was removed
  request-property-default-value-removed
- ○
  the response's property default value openid was removed for the status
  response-property-default-value-removed
- ○
  the response's property default value email was removed for the status
  response-property-default-value-removed
- ○
  the response's property default value groups was removed for the status
  response-property-default-value-removed
- ○
  the response's property default value name was removed for the status
  response-property-default-value-removed
- ○
  the response's property default value email openid profile was removed for the status
  response-property-default-value-removed
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 202576b0fefddb0d10See the full diff
- ○
  the request property default value openid was added
  request-property-default-value-added
- ○
  the request property default value email was added
  request-property-default-value-added
- ○
  the request property default value groups was added
  request-property-default-value-added
- ○
  the request property default value name was added
  request-property-default-value-added
- ○
  the request property default value email openid profile was added
  request-property-default-value-added
- ○
  the response's property default value openid was added for the status
  response-property-default-value-added
- ○
  the response's property default value email was added for the status
  response-property-default-value-added
- ○
  the response's property default value groups was added for the status
  response-property-default-value-added
- ○
  the response's property default value name was added for the status
  response-property-default-value-added
- ○
  the response's property default value email openid profile was added for the status
  response-property-default-value-added
Jul 1, 20259a3d26a000881See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history