---
title: "Update Auth Settings"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37/operations/update-portal-authentication-settings"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37.md

# Update Auth Settings

`PATCH` `/portals/{portalId}/authentication-settings`

Operation ID: `update-portal-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 (SSO) through an OIDC Identity Provider (IdP). Developers can be automatically assigned to teams by mapping claims from thier IdP account.

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.

## Request body

Content types: `application/json`

## Responses

- `200` - Details about a portal's authentication settings.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management
  version: 2.2.2
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
paths:
  /portals/{portalId}/authentication-settings:
    parameters:
      - $ref: "#/components/parameters/PortalId"
    patch:
      operationId: update-portal-authentication-settings
      summary: Update Auth Settings
      description: Updates the developer authentication configuration for a portal.
        Developers can be allowed to login using basic auth (email & password)
        or use Single-Sign-On (SSO) through an OIDC Identity Provider (IdP).
        Developers can be automatically assigned to teams by mapping claims from
        thier IdP account.
      requestBody:
        $ref: "#/components/requestBodies/UpdatePortalAuthenticationSettings"
      responses:
        "200":
          $ref: "#/components/responses/PortalAuthenticationSettings"
        "400":
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                UpdateAuthSettingsBadRequestExample1:
                  $ref: "#/components/examples/UpdateAuthSettingsBadRequestExample1"
                UpdateAuthSettingsBadRequestExample2:
                  $ref: "#/components/examples/UpdateAuthSettingsBadRequestExample2"
                UpdateAuthSettingsBadRequestExample3:
                  $ref: "#/components/examples/UpdateAuthSettingsBadRequestExample3"
                UpdateAuthSettingsBadRequestExample4:
                  $ref: "#/components/examples/UpdateAuthSettingsBadRequestExample4"
                UpdateAuthSettingsBadRequestExample5:
                  $ref: "#/components/examples/UpdateAuthSettingsBadRequestExample5"
                UpdateAuthSettingsBadRequestExample6:
                  $ref: "#/components/examples/UpdateAuthSettingsBadRequestExample6"
                UpdateAuthSettingsBadRequestExample7:
                  $ref: "#/components/examples/UpdateAuthSettingsBadRequestExample7"
                UpdateAuthSettingsBadRequestExample8:
                  $ref: "#/components/examples/UpdateAuthSettingsBadRequestExample8"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Portal Auth Settings
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
  requestBodies:
    UpdatePortalAuthenticationSettings:
      description: Update a portal's developer authentication settings.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PortalAuthenticationSettingsUpdateRequest"
          examples:
            Example 1:
              $ref: "#/components/examples/UpdatePortalAuthenticationSettingsExample1"
            Disable Basic Developer Auth:
              $ref: "#/components/examples/UpdatePortalAuthenticationSettingsExampleDisableBa\
                sicAuth"
            Enable OIDC Developer Auth:
              $ref: "#/components/examples/UpdatePortalAuthenticationSettingsExampleEnableOID\
                C"
            Enable OIDC Team Mapping:
              $ref: "#/components/examples/UpdatePortalAuthenticationSettingsExampleEnableOID\
                CTeamMapping"
  responses:
    PortalAuthenticationSettings:
      description: Details about a portal's authentication settings.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PortalAuthenticationSettingsResponse"
          examples:
            Example 1:
              $ref: "#/components/examples/PortalAuthenticationSettingsExample1"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
  schemas:
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    PortalAuthenticationSettingsUpdateRequest:
      description: Properties to update a portal's developer auth settings.
      type: object
      properties:
        basic_auth_enabled:
          description: The organization has basic auth enabled.
          type: boolean
          example: true
        oidc_auth_enabled:
          description: The organization has OIDC disabled.
          type: boolean
          example: false
        saml_auth_enabled:
          description: The portal has SAML enabled or disabled.
          type: boolean
          example: false
        oidc_team_mapping_enabled:
          description: Whether IdP groups determine the Konnect Portal teams a developer
            has.
          type: boolean
          example: true
        konnect_mapping_enabled:
          description: Whether a Konnect Identity Admin assigns teams to a developer.
          type: boolean
          example: false
        idp_mapping_enabled:
          description: Whether IdP groups determine the Konnect Portal teams a developer
            has. This will soon replace oidc_team_mapping_enabled.
          type: boolean
          example: true
        oidc_issuer:
          type: string
        oidc_client_id:
          type: string
        oidc_client_secret:
          type: string
        oidc_scopes:
          type: array
          items:
            type: string
            default: openid
          default:
            - email
            - openid
            - profile
        oidc_claim_mappings:
          $ref: "#/components/schemas/PortalClaimMappings"
      example:
        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
      title: PortalAuthenticationSettingsUpdateRequest
    PortalAuthenticationSettingsResponse:
      description: The developer authentication settings for a portal.
      type: object
      properties:
        basic_auth_enabled:
          description: The portal has basic auth enabled or disabled.
          type: boolean
          example: true
        oidc_auth_enabled:
          description: The portal has OIDC enabled or disabled.
          type: boolean
          example: false
        saml_auth_enabled:
          description: The portal has SAML enabled or disabled.
          type: boolean
          example: false
        oidc_team_mapping_enabled:
          description: IdP groups determine the Portal Teams a developer has.
          type: boolean
          example: true
        idp_mapping_enabled:
          description: IdP groups determine the Portal Teams a developer has. This will
            soon replace oidc_team_mapping_enabled.
          type: boolean
          example: true
        konnect_mapping_enabled:
          description: A Konnect Identity Admin assigns teams to a developer.
          type: boolean
          example: false
        oidc_config:
          $ref: "#/components/schemas/PortalOIDCConfig"
      example:
        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
      required:
        - basic_auth_enabled
        - konnect_mapping_enabled
        - oidc_auth_enabled
        - oidc_team_mapping_enabled
      title: PortalAuthenticationSettingsResponse
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    PortalClaimMappings:
      description: Mappings from a portal developer atribute to an Identity Provider claim.
      type: object
      properties:
        name:
          type: string
          example: name
          default: name
        email:
          type: string
          example: email
          default: email
        groups:
          type: string
          example: custom-group-claim
          default: groups
      example:
        name: name
        email: email
        groups: custom-group-claim
      maxProperties: 3
      minProperties: 0
      title: PortalClaimMappings
    PortalOIDCConfig:
      description: Configuration properties for an OpenID Connect Identity Provider.
      type: object
      properties:
        issuer:
          type: string
          example: https://identity.example.com/v2
        client_id:
          type: string
          example: x7id0o42lklas0blidl2
        scopes:
          type: array
          items:
            type: string
            default: openid
          example:
            - email
            - openid
            - profile
          default:
            - email
            - openid
            - profile
        claim_mappings:
          $ref: "#/components/schemas/PortalClaimMappings"
      example:
        issuer: https://identity.example.com/v2
        client_id: x7id0o42lklas0blidl2
        scopes:
          - email
          - openid
          - profile
        claim_mappings:
          name: name
          email: email
          groups: custom-group-claim
      required:
        - issuer
        - client_id
      title: PortalOIDCConfig
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    UpdateAuthSettingsBadRequestExample1:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: basic_auth_enabled
            rule: is_boolean
            reason: value of "basic_auth_enabled" must be true or false
            source: body
    UpdateAuthSettingsBadRequestExample2:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: oidc_auth_enabled
            rule: is_boolean
            reason: value of "oidc_auth_enabled" must be true or false
            source: body
    UpdateAuthSettingsBadRequestExample3:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: oidc_team_mapping_enabled
            rule: is_boolean
            reason: value of "oidc_team_mapping_enabled" must be true or false
            source: body
    UpdateAuthSettingsBadRequestExample4:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: konnect_mapping_enabled
            rule: is_boolean
            reason: value of "konnect_mapping_enabled" must be true or false
            source: body
    UpdateAuthSettingsBadRequestExample5:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: oidc_issuer
            rule: is_string
            reason: value of "oidc_issuer" must be a utf-8 string
            source: body
    UpdateAuthSettingsBadRequestExample6:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: oidc_client_id
            rule: is_string
            reason: value of "oidc_client_id" must be a utf-8 string
            source: body
    UpdateAuthSettingsBadRequestExample7:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: oidc_client_secret
            rule: is_string
            reason: value of "oidc_client_secret" must be a utf-8 string
            source: body
    UpdateAuthSettingsBadRequestExample8:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: oidc_scopes
            rule: is_array
            reason: '"oidc_scopes" must be an array'
            source: body
    UpdatePortalAuthenticationSettingsExample1:
      value:
        basic_auth_enabled: true
        oidc_auth_enabled: true
        saml_auth_enabled: true
        oidc_team_mapping_enabled: true
        konnect_mapping_enabled: false
        idp_mapping_enabled: true
        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
    UpdatePortalAuthenticationSettingsExampleDisableBasicAuth:
      value:
        basic_auth_enabled: false
    UpdatePortalAuthenticationSettingsExampleEnableOIDC:
      value:
        oidc_auth_enabled: true
        oidc_team_mapping_enabled: false
        konnect_mapping_enabled: true
        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
    UpdatePortalAuthenticationSettingsExampleEnableOIDCTeamMapping:
      value:
        oidc_team_mapping_enabled: true
        konnect_mapping_enabled: true
        oidc_claim_mappings:
          name: name
          email: email
          groups: custom-group-claim
    PortalAuthenticationSettingsExample1:
      value:
        basic_auth_enabled: true
        oidc_auth_enabled: true
        saml_auth_enabled: true
        oidc_team_mapping_enabled: true
        konnect_mapping_enabled: true
        idp_mapping_enabled: true
        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
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
