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

Changed in 4 of the 30 revisions of this API.8130

  • 106b373707f35See the full diff
    • ○

      added the optional property oidc_claim_mappings to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oidc_client_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oidc_issuer to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oidc_scopes to the response with the 200 status

      response-optional-property-added

    • ○

      the response optional property oidc_config became read-only for the status 200

      response-optional-property-became-read-only

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0325d14dfc53113See the full diff
    • ▲

      the response property oidc_config became nullable for the status 200

      response-property-became-nullable

    • ○

      the request property oidc_claim_mappings became nullable

      request-property-became-nullable

    • ○

      request property oidc_auth_enabled deprecated

      request-property-deprecated

    • ○

      request property oidc_claim_mappings deprecated

      request-property-deprecated

    • ○

      request property oidc_client_id deprecated

      request-property-deprecated

    • ○

      request property oidc_client_secret deprecated

      request-property-deprecated

    • ○

      request property oidc_issuer deprecated

      request-property-deprecated

    • ○

      request property oidc_scopes deprecated

      request-property-deprecated

    • ○

      request property oidc_team_mapping_enabled deprecated

      request-property-deprecated

    • ○

      request property saml_auth_enabled 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 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5d2b35832e3f1See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    This revision also has 57 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ecce2daf9de6712See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property idp_mapping_enabled became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property saml_auth_enabled became nullable for the status 200

      response-property-became-nullable

    • ○

      the request property oidc_client_id became nullable

      request-property-became-nullable

    • ○

      the request property oidc_client_secret became nullable

      request-property-became-nullable

    • ○

      the request property oidc_issuer became nullable

      request-property-became-nullable

    • ○

      the request property oidc_scopes became nullable

      request-property-became-nullable

    • ○

      the email request property default value email was added

      request-property-default-value-added

    • ○

      the groups request property default value groups was added

      request-property-default-value-added

    • ○

      the name request property default value name was added

      request-property-default-value-added

    • ○

      the response's property default value openid was added for the status 200

      response-property-default-value-added

    • ○

      the email response's property default value email was added for the status 200

      response-property-default-value-added

    • ○

      the groups response's property default value groups was added for the status 200

      response-property-default-value-added

    • ○

      the name response's property default value name was added for the status 200

      response-property-default-value-added

    • ○

      the scopes response's property default value email openid profile was added for the status 200

      response-property-default-value-added