SAML Identity Provider Metadata

string

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

Example

Create Identity Provider

object

The identity provider that contains configuration data for creating an authentication integration.

typestring

Specifies the type of identity provider.

Allowed values:oidcsaml

Example:oidc

enabledboolean

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

login_pathstring

The path used for initiating login requests with the identity provider.

Example:myapp

configOne Of
object
OIDC Identity Provider Configobject

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

* Additional properties are NOT allowed.
Show Child Parameters
Example

Update Identity Provider

object

The identity provider that contains configuration data for updating an authentication integration.

enabledboolean

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

login_pathstring

The path used for initiating login requests with the identity provider.

Example:myapp

configOne Of
object
OIDC Identity Provider Configobject

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

* Additional properties are NOT allowed.
Show Child Parameters
Example

Identity Provider

object

The identity provider that contains configuration data for authentication integration.

idstring(uuid)read-only

Contains a unique identifier used for this resource.

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

typestring

Specifies the type of identity provider.

Allowed values:oidcsaml

Example:oidc

enabledboolean

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

login_pathstring

The path used for initiating login requests with the identity provider.

Example:myapp

configOne Of
object
OIDC Identity Provider Configobject

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

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

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