OIDC Identity Provider Config

object

The identity provider that contains configuration data for the OIDC authentication integration.

* Additional properties are NOT allowed.
issuer_urlstring(uri)required

The issuer URI of the identity provider. This is the URL where the provider’s metadata can be obtained.

Example:https://konghq.okta.com/oauth2/default

client_idstringrequired

The client ID assigned to your application by the identity provider.

Example:YOUR_CLIENT_ID

client_secretstring

The Client Secret assigned to your application by the identity provider.

Example:YOUR_CLIENT_SECRET

scopesarray[string]

The scopes requested by your application when authenticating with the identity provider.

Default:email, openid, profile

claim_mappingsobject

Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for
authentication.

Show Child Parameters
Example

SAML Identity Provider Config

object

The identity provider that contains configuration data for the SAML authentication integration.

* Additional properties are NOT allowed.
idp_metadata_urlstring(uri)

The identity provider’s metadata URL where the identity provider’s metadata can be obtained.

Example:https://mocksaml.com/api/saml/metadata

idp_metadata_xmlstring

The identity provider’s SAML metadata. If the identity provider supports a metadata URL, you can use the idp_metadata_url field instead.

Example:<?xml version="1.0" encoding="UTF-8"?> <EntityDescriptor xmlns="urn:oasis:names:tc:SAML:2.0:metadata"> <!-- SAML metadata content here --> </EntityDescriptor>

sp_metadata_urlstring(uri)read-only

Example:https://cloud.konghq.com/v2/authenticate/the-saml-konnect-org/saml/metadata

sp_entity_idstringread-only

The entity ID of the service provider (SP).

Example:https://cloud.konghq.com/sp/00000000-0000-0000-0000-000000000000

login_urlstringread-only

The URL to redirect users to for initiating login with the identity provider.

Example:https://cloud.konghq.com/login/the-saml-konnect-org

callback_urlstring(uri)read-only

The URL where the SAML identity provider sends authentication responses after successful login attempts.

Example:https://cloud.konghq.com/v2/authenticate/the-saml-konnect-org/saml/acs

Example

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