---
title: "Update Auth Settings"
method: PATCH
path: "/v3/portals/{portalId}/authentication-settings"
tags: ["Portal Auth Settings"]
---

# Update Auth Settings

`PATCH /v3/portals/{portalId}/authentication-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.

## Request body

- PortalAuthenticationSettingsUpdateRequest — Properties to update a portal's developer auth settings.
  - `basic_auth_enabled` boolean — The organization has basic auth enabled.
  - `oidc_auth_enabled` boolean — Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.
  - `saml_auth_enabled` boolean — Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.
  - `oidc_team_mapping_enabled` boolean — IdP groups determine the Portal Teams a developer has. Replaced by idp_mapping_enabled.
  - `konnect_mapping_enabled` boolean — Whether a Konnect Identity Admin assigns teams to a developer.
  - `idp_mapping_enabled` boolean — Whether IdP groups determine the Konnect Portal teams a developer has.
  - `oidc_issuer` string, nullable — Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.
  - `oidc_client_id` string, nullable — Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.
  - `oidc_client_secret` string, nullable — Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.
  - `oidc_scopes` string[], nullable — Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.
  - `oidc_claim_mappings` object, nullable — Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.
    - `name` string
    - `email` string
    - `groups` string

## Response `200`

Details about a portal's authentication settings.

- PortalAuthenticationSettingsResponse — The developer authentication settings for a portal.
  - `basic_auth_enabled` boolean, required — The portal has basic auth enabled or disabled.
  - `oidc_auth_enabled` boolean, required — The portal has OIDC enabled or disabled.
  - `saml_auth_enabled` boolean — A Konnect Identity Admin assigns teams to a developer.
  - `oidc_team_mapping_enabled` boolean, required — IdP groups determine the Portal Teams a developer has. Replaced by idp_mapping_enabled.
  - `idp_mapping_enabled` boolean — Whether IdP groups determine the Konnect Portal teams a developer has.
  - `konnect_mapping_enabled` boolean, required — A Konnect Identity Admin assigns teams to a developer.
  - `oidc_config` object — Configuration properties for an OpenID Connect Identity Provider.
    - `issuer` string, required
    - `client_id` string, required
    - `scopes` string[]
    - `claim_mappings` PortalClaimMappings — Mappings from a portal developer atribute to an Identity Provider claim.
      - `name` string
      - `email` string
      - `groups` string
  - `oidc_issuer` string, nullable
  - `oidc_client_id` string, nullable
  - `oidc_scopes` string[], nullable
  - `oidc_claim_mappings` object, nullable — Mappings from a portal developer atribute to an Identity Provider claim.
    - `name` string
    - `email` string
    - `groups` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden

## Changes

- **2026-01-30** `4b75c54c0f2b` — 5 info
  - added the optional property `oidc_claim_mappings` to the response with the `200` status
  - added the optional property `oidc_client_id` to the response with the `200` status
  - added the optional property `oidc_issuer` to the response with the `200` status
  - added the optional property `oidc_scopes` to the response with the `200` status
  - …1 more
- **2025-12-16** `46e7fcea2356` — 1 breaking, 13 info
  - the response property `oidc_config` became nullable for the status `200`
  - the request property `oidc_claim_mappings` became nullable
  - request property `oidc_auth_enabled` deprecated
  - request property `oidc_claim_mappings` deprecated
  - …10 more
- **2025-10-29** `19e869275e28` — 1 warning
  - added the new `type` enum value to the `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterStandard]/rule` response property for the response status `400`
- **2025-08-22** `96118a9cd7f4` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/kong/apis/konnect-api/changes/v3/portals/:portalId/authentication-settings/patch.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api.md) · [All operations](https://skmtc.dev/kong/apis/konnect-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kong/konnect-api/revisions/72502a676a92/schema)