AddDeveloperToTeamRequest

object

Add a developer to a team by specifying the developer ID.

idstring(uuid)required

Example:df120cb4-f60b-47bc-a2f8-6a28e6a3c63b

Example

PortalAssignRoleRequest

object

An assigned role associates a service and an action to a team.

role_namestringrequired

Example:API Viewer

entity_idstring(uuid)required

Example:e67490ce-44dc-4cbd-b65e-b52c746fc26a

entity_type_namestringrequired

Example:Services

entity_regionstringrequired

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

Example

PortalAuthenticationSettingsUpdateRequest

object

Properties to update a portal’s developer auth settings.

basic_auth_enabledboolean

The organization has basic auth enabled.

Example:true

oidc_auth_enabledbooleanDEPRECATED

Deprecated. Use the Identity Provider API instead.

saml_auth_enabledbooleanDEPRECATED

Deprecated. Use the Identity Provider API instead.

oidc_team_mapping_enabledbooleanDEPRECATED

IdP groups determine the Portal Teams a developer has. Replaced by idp_mapping_enabled.

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.

Example:true

oidc_issuerstringDEPRECATED

Deprecated. Use the Identity Provider API instead.

oidc_client_idstringDEPRECATED

Deprecated. Use the Identity Provider API instead.

oidc_client_secretstringDEPRECATED

Deprecated. Use the Identity Provider API instead.

oidc_scopesarray[string]DEPRECATED

Deprecated. Use the Identity Provider API instead.

Default:openid

oidc_claim_mappingsobjectDEPRECATED

Deprecated. Use the Identity Provider API instead.

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.

can_own_applicationsboolean

Whether the team is allowed to own applications.

Example:true

Example