SAML Identity Provider Metadata URL

string

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

Example

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

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(path)read-only

Example:/api/v2/developer/authenticate/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

callback_urlstring(path)read-only

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

Example:/api/v2/developer/authenticate/saml/acs

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

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

Identity Provider

object

The identity provider that contains configuration data for creating 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

typestring

Specifies the type of identity provider.

Allowed values:oidcsaml

Example:oidc

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