PortalClaimMappings

object

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

namestring

Default:name

Example:name

emailstring

Default:email

Example:email

groupsstring

Default:groups

Example:custom-group-claim

Example

PortalOIDCConfig

object

Configuration properties for an OpenID Connect Identity Provider.

issuerstringrequired

Example:https://identity.example.com/v2

client_idstringrequired

Example:x7id0o42lklas0blidl2

scopesarray[string]

Default:openid

Example:email, openid, profile

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

PortalAuthenticationSettingsResponse

object

The developer authentication settings for a portal.

basic_auth_enabledbooleanrequired

The portal has basic auth enabled or disabled.

Example:true

oidc_auth_enabledbooleanrequired

The portal has OIDC enabled or disabled.

saml_auth_enabledboolean

The portal has SAML enabled or disabled.

oidc_team_mapping_enabledbooleanrequired

IdP groups determine the Portal Teams a developer has.

Example:true

idp_mapping_enabledboolean

IdP groups determine the Portal Teams a developer has. This will soon replace oidc_team_mapping_enabled.

Example:true

konnect_mapping_enabledbooleanrequired

A Konnect Identity Admin assigns teams to a developer.

oidc_configobject

Configuration properties for an OpenID Connect Identity Provider.

Example:{"issuer":"https://identity.example.com/v2","client_id":"x7id0o42lklas0blidl2","scopes":["email","openid","profile"],"claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}}

Show Child Parameters
Example

AssignedPortalRoleCollectionResponse

object

A paginated list of roles assigned to a team.

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

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

Example:{"id":"1a3c2169-27f8-4594-926b-41df3432d5dc","role_name":"API Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Services","entity_region":"us"}

Show Child Parameters
Example

ListPortalTeamsResponse

object

A paginated list of teams in a portal.

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Details about a developer team.

Example:{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"IDM - Developers","description":"The developers for the IDM API.","created_at":"1992-02-07T17:46:57.52Z","updated_at":"2022-08-31T17:00:00.52Z"}

Show Child Parameters
Example