Identity Provider
objectThe identity provider that contains configuration data for authentication integration.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Specifies the type of identity provider.
Allowed values:oidcsaml
Example:oidc
Indicates whether the identity provider is enabled.
Only one identity provider can be active at a time, such as SAML or OIDC.
Default:false
Example:true
The path used for initiating login requests with the identity provider.
Example:myapp
One OfThe identity provider that contains configuration data for the OIDC authentication integration.
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
OIDC Identity Provider Config
objectThe identity provider that contains configuration data for the OIDC authentication integration.
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
The client ID assigned to your application by the identity provider.
Example:YOUR_CLIENT_ID
The Client Secret assigned to your application by the identity provider.
Example:YOUR_CLIENT_SECRET
The scopes requested by your application when authenticating with the identity provider.
Default:email, openid, profile
Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for
authentication.
Show Child Parameters
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