IdP Configuration

object

The IdP object contains the configuration data for the OIDC authentication integration.

NOTE: The openid scope is required. Removing it could break the OIDC integration.

issuerstring(uri)

Example:https://myidp.com/oauth2

login_pathstring

Example:myapp

client_idstring

Example:YOUR_CLIENT_ID

scopesarray[string]

Default:email, openid, profile

claim_mappingsobject
Show Child Parameters
Example

User

object

The user object contains information about an individual user who can use the Konnect application and API.

idstring(uuid)read-only

The User ID.

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

emailstring(email)

The email registered to the user.

<= 250 characters

Example:user@email.com

full_namestring

The User’s full name.

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

<= 250 characters

Example:Jane Doe

preferred_namestring

The User’s preferred name.

<= 250 characters

Example:Jane

activebooleanread-only

Returns True if a user has verified their email address.

Default:true

inferred_regionstringread-only

The Konnect region closest to the user’s IP address. This property might only be set for users on signup through Konnect’s build-in native authentication.

Example:us

created_atstring(date-time)read-only

The time stamp for the date the account was registered.

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

updated_atstring(date-time)read-only

A Unix timestamp representation of the most recent change to the User account.

Example:2022-10-08T17:00:00.52Z

Example

Team

object

The team object contains information about a group of users.

idstring(uuid)read-only

The team ID.

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

namestring

The name of the team.

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

<= 250 characters

Example:IDM - Developers

descriptionstring

The team description in Konnect.

<= 250 characters

Example:The developers for the IDM API.

system_teambooleanread-only

Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like “Organization Admin”, or “Service”

Default:false

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

created_atstring(date-time)read-only

A Unix timestamp representation of team creation.

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

updated_atstring(date-time)read-only

A Unix timestamp representation of the most recent change to the team object in Konnect.

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

Example

TeamMapping

object

A team assignment is a mapping of an IdP group to a Konnect Team.

groupstring

The IdP group.

Example:Service Developers

team_idsarray[string](uuid)unique-items

An array of ID’s that are mapped to the specified group.

Example:6801e673-cc10-498a-94cd-4271de07a0d3

Example

TeamGroupMapping

object

A map of Konnect Team to IdP groups.

team_idstring(uuid)

The Konnect team ID.

Example:6801e673-cc10-498a-94cd-4271de07a0d3

groupsarray[string]unique-items

The IdP groups that are mapped to the specified team.

Example:API Engineers

Example