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
https://global.api.konghq.com/v3/identity-providers/{id}

Path Parameters

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

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

get/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
https://global.api.konghq.com/v3/identity-providers/{id}

Path Parameters

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.

Update 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

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

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

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

patch/identity-providers/{id}

Body

{ "enabled": true, "login_path": "the-oidc-konnect-org", "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 organization.

delete
https://global.api.konghq.com/v3/identity-providers/{id}

Path Parameters

idstring(uuid)required

ID of the identity provider.

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

Response

No Content

delete/identity-providers/{id}
 

Get the IdP Configuration

Fetch the IdP configuration.

get
https://global.api.konghq.com/v3/identity-provider

Response

application/json

A get action response of the IdP configuration.

IdP Configuration

The IdP object contains the configuration data for the OIDC authentication integration.

NOTE: The openid scope is required. Removing it could break the OIDC integration.

issuerstring(uri)

Example:https://myidp.com/oauth2

login_pathstring

Example:myapp

client_idstring

Example:YOUR_CLIENT_ID

scopesarray[string]

Default:email, openid, profile

claim_mappingsobject
Show Child Parameters
get/identity-provider
 
application/json

Update IdP Configuration

Update the IdP configuration.

patch
https://global.api.konghq.com/v3/identity-provider

Body

application/json

The request schema for the update IdP configuration request.

issuerstring(uri)

Example:https://myidp.com/oauth2

login_pathstring

Example:myapp

client_idstring

Example:YOUR_CLIENT_ID

client_secretstring

Example:YOUR_CLIENT_SECRET

scopesarray[string]

Default:openid

claim_mappingsobject
Show Child Parameters

Response

application/json

A get action response of the IdP configuration.

IdP Configuration

The IdP object contains the configuration data for the OIDC authentication integration.

NOTE: The openid scope is required. Removing it could break the OIDC integration.

issuerstring(uri)

Example:https://myidp.com/oauth2

login_pathstring

Example:myapp

client_idstring

Example:YOUR_CLIENT_ID

scopesarray[string]

Default:email, openid, profile

claim_mappingsobject
Show Child Parameters
patch/identity-provider

Body

{}
 
application/json