SAML Identity Provider Config
objectThe identity provider that contains configuration data for the SAML authentication integration.
The identity provider’s metadata URL where the identity provider’s metadata can be obtained.
Example:https://mocksaml.com/api/saml/metadata
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>
Example:https://cloud.konghq.com/v2/authenticate/the-saml-konnect-org/saml/metadata
The entity ID of the service provider (SP).
Example:https://cloud.konghq.com/sp/00000000-0000-0000-0000-000000000000
The URL to redirect users to for initiating login with the identity provider.
Example:https://cloud.konghq.com/login/the-saml-konnect-org
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
IdP Configuration
objectThe IdP object contains the configuration data for the OIDC authentication integration.
NOTE: The openid scope is required. Removing it could break the OIDC integration.
Example:https://myidp.com/oauth2
Example:myapp
Example:YOUR_CLIENT_ID
Default:email, openid, profile
Show Child Parameters
User
objectThe user object contains information about an individual user who can use the Konnect application and API.
The User ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The email registered to the user.
<= 250 characters
Example:user@email.com
The User’s full name.
Match pattern:^[\w \W]+$
<= 250 characters
Example:Jane Doe
The User’s preferred name.
<= 250 characters
Example:Jane
Returns True if a user has verified their email address.
Default:true
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
The time stamp for the date the account was registered.
Example:2022-02-07T17:46:57.52Z
A Unix timestamp representation of the most recent change to the User account.
Example:2022-10-08T17:00:00.52Z
Team
objectThe team object contains information about a group of users.
The team ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the team.
Match pattern:^[\w \W]+$
<= 250 characters
Example:IDM - Developers
The team description in Konnect.
<= 250 characters
Example:The developers for the IDM API.
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
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"}
A Unix timestamp representation of team creation.
Example:1992-02-07T17:46:57.52Z
A Unix timestamp representation of the most recent change to the team object in Konnect.
Example:2022-02-07T17:00:00.52Z
TeamMapping
objectA team assignment is a mapping of an IdP group to a Konnect Team.
The IdP group.
Example:Service Developers
An array of ID’s that are mapped to the specified group.
Example:6801e673-cc10-498a-94cd-4271de07a0d3