PortalAuthenticationSettingsUpdateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PortalAuthenticationSettingsUpdateRequest",
  "title": "PortalAuthenticationSettingsUpdateRequest",
  "x-speakeasy-entity": "PortalAuth",
  "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,
      "x-speakeasy-param-computed": true
    },
    "oidc_auth_enabled": {
      "description": "Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.",
      "type": "boolean",
      "example": false,
      "deprecated": true,
      "x-speakeasy-param-computed": true
    },
    "saml_auth_enabled": {
      "description": "Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.",
      "type": "boolean",
      "example": false,
      "deprecated": true,
      "x-speakeasy-param-computed": true
    },
    "oidc_team_mapping_enabled": {
      "$ref": "#/components/schemas/OIDCIdpMappingEnabled"
    },
    "konnect_mapping_enabled": {
      "description": "Whether a Konnect Identity Admin assigns teams to a developer.",
      "type": "boolean",
      "example": false,
      "x-speakeasy-param-computed": true
    },
    "idp_mapping_enabled": {
      "$ref": "#/components/schemas/IDPMappingEnabled"
    },
    "oidc_issuer": {
      "description": "Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.",
      "type": "string",
      "deprecated": true
    },
    "oidc_client_id": {
      "description": "Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.",
      "type": "string",
      "deprecated": true
    },
    "oidc_client_secret": {
      "description": "Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.",
      "type": "string",
      "deprecated": true
    },
    "oidc_scopes": {
      "description": "Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.",
      "type": "array",
      "items": {
        "type": "string",
        "default": "openid"
      },
      "default": [
        "email",
        "openid",
        "profile"
      ],
      "deprecated": true
    },
    "oidc_claim_mappings": {
      "description": "Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.",
      "type": "object",
      "example": {
        "name": "name",
        "email": "email",
        "groups": "custom-group-claim"
      },
      "deprecated": true,
      "maxProperties": 3,
      "minProperties": 0,
      "properties": {
        "name": {
          "type": "string",
          "example": "name",
          "default": "name"
        },
        "email": {
          "type": "string",
          "example": "email",
          "default": "email"
        },
        "groups": {
          "type": "string",
          "example": "custom-group-claim",
          "default": "groups"
        }
      },
      "title": "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"
    }
  }
}