List Identity Providers

Retrieves the identity providers available within the portal. This operation provides information about
various identity providers for SAML or OIDC authentication integrations.

get

Query Parameters

filterobject

Filter identity providers returned in the response.

Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A collection of identity providers. This response contains a collection of identity providers, which may include both OIDC and SAML identity providers.

Identity Provider Collection Response

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

get/portals/{portalId}/identity-providers
 
application/json

Create Identity Provider

Creates a new identity provider. This operation allows the creation of a new identity provider for
authentication purposes.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

An object representing the configuration for creating a new identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.

Identity Provider

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

Response

application/json

An identity provider configuration. This response represents the configuration of a specific identity provider, which can be either OIDC or SAML.

Identity Provider

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

post/portals/{portalId}/identity-providers

Body

{ "type": "oidc", "config": { "issuer_url": "https://konghq.okta.com/oauth2/default", "client_id": "0oaqhb43ckTZ02j1F357", "client_secret": "BbqwI8xP9E4evOK", "scopes": [ "openid", "email", "profile" ], "claim_mappings": { "email": "email", "name": "name", "groups": "groups" } } }
 
application/json

Get Identity Provider

Retrieves the configuration of a single identity provider. This operation returns information about a
specific identity provider’s settings and authentication integration details.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

idstring(uuid)required

ID of the identity provider.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

An identity provider configuration. This response represents the configuration of a specific identity provider, which can be either OIDC or SAML.

Identity Provider

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

get/portals/{portalId}/identity-providers/{id}
 
application/json

Update Identity Provider

Updates the configuration of an existing identity provider. This operation allows modifications to be made
to an existing identity provider’s configuration.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

idstring(uuid)required

ID of the identity provider.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

An object representing the configuration for updating an identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.

Identity Provider

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

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

Response

application/json

An identity provider configuration. This response represents the configuration of a specific identity provider, which can be either OIDC or SAML.

Identity Provider

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

patch/portals/{portalId}/identity-providers/{id}

Body

{ "enabled": true, "config": { "issuer_url": "https://konghq.okta.com/oauth2/default", "client_id": "0oaqhb43ckTZ02j1F357", "client_secret": "BbqwI8xP9E4evOK", "scopes": [ "openid", "email", "profile" ], "claim_mappings": { "email": "email", "name": "name", "groups": "groups" } } }
 
application/json

Delete Identity Provider

Deletes an existing identity provider configuration. This operation removes a specific identity provider
from the portal.

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

idstring(uuid)required

ID of the identity provider.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

No Content

delete/portals/{portalId}/identity-providers/{id}