PortalAuthenticationSettingsUpdateRequest

object

Properties to update a portal’s developer auth settings.

basic_auth_enabledboolean

The organization has basic auth enabled.

Example:true

oidc_auth_enabledboolean

The organization has OIDC disabled.

saml_auth_enabledboolean

The portal has SAML enabled or disabled.

oidc_team_mapping_enabledboolean

Whether IdP groups determine the Konnect Portal teams a developer has.

Example:true

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. This will soon replace oidc_team_mapping_enabled.

Example:true

oidc_issuerstring
oidc_client_idstring
oidc_client_secretstring
oidc_scopesarray[string]

Default:openid

oidc_claim_mappingsobject

Mappings from a portal developer atribute to an Identity Provider claim.

Example:{"name":"name","email":"email","groups":"custom-group-claim"}

Show Child Parameters
Example

PortalTeamGroupMappingsUpdateRequest

object

A set of mappings to update from a team to their groups.

dataarray[object]

The IdP groups to map to the given team.

Show Child Parameters
Example

PortalUpdateTeamRequest

object

Properties to update on a team.

namestring

Match pattern:^[\w \W]+$

Example:IDM - Developers

descriptionstring

<= 250 characters

Example:The Identity Management (IDM) API team.

Example

PortalCreateTeamRequest

object

Details about a team to create.

namestringrequired

Match pattern:^[\w \W]+$

Example:IDM - Developers

descriptionstring

<= 250 characters

Example:The Identity Management (IDM) team.

Example

PortalTeamResponse

object

Details about a developer team.

idstring(uuid)read-only

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

Match pattern:^[\w \W]+$

<= 250 characters

Example:IDM - Developers

descriptionstring

<= 250 characters

Example:The developers for the IDM API.

created_atstring(date-time)read-only

Example:1992-02-07T17:46:57.52Z

updated_atstring(date-time)read-only

Example:2022-02-07T17:00:00.52Z

Example