Get the IdP Configuration

Fetch the IdP configuration.

get
https://global.api.konghq.com/v2/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/v2/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

Update Team Mappings

Updates the IdP group to Konnect team mapping.

put
https://global.api.konghq.com/v2/identity-provider/team-mappings

Body

application/json

The request schema for updating IdP team mappings.

mappingsarray[object]

The mappings object.

Show Child Parameters

Response

application/json

A paginated list response for a collection of team mappings.

dataarray[object]

A team assignment is a mapping of an IdP group to a Konnect Team.

Example:{"group":"Service Developers","team_ids":["6801e673-cc10-498a-94cd-4271de07a0d3"]}

Show Child Parameters
put/identity-provider/team-mappings

Body

{ "mappings": [ { "group": "Service Developers", "team_ids": [ "af91db4c-6e51-403e-a2bf-33d27ae50c0a" ] } ] }
 
application/json

Get the Team Mapping

Fetch the IdP group to Konnect team mapping.

get
https://global.api.konghq.com/v2/identity-provider/team-mappings

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Response

application/json

A paginated list response for a collection of team mappings.

metaobject

Contains pagination data.

Show Child Parameters
dataarray[object]
Show Child Parameters
get/identity-provider/team-mappings
 
application/json

Get the Team Group Mappings

Retrieves the mappings between Konnect Teams and Identity Provider Groups.
Returns a 400 error if an Identity Provider has not yet been configured.

get
https://global.api.konghq.com/v2/identity-provider/team-group-mappings

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Response

application/json

A paginated collection of mappings grouped by team_id.

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

A map of Konnect Team to IdP groups.

Example:{"team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","groups":["Tech Leads","API Engineers"]}

Show Child Parameters
get/identity-provider/team-group-mappings
 
application/json