Get Auth Settings

Returns authentication configuration, which determines how users can log in and how they are assigned to teams.

get
https://global.api.konghq.com/v2/authentication-settings

Response

application/json

Response for authentication settings endpoint

basic_auth_enabledboolean

The organization has basic auth enabled.

Example:true

oidc_auth_enabledboolean

The organization has OIDC disabled.

Example:false

saml_auth_enabledboolean

The organization has SAML disabled.

Example:false

idp_mapping_enabledboolean

IdP groups determine the Konnect teams a user has.

Example:true

konnect_mapping_enabledboolean

A Konnect Identity Admin assigns teams to a user.

Example:false

get/authentication-settings
 
application/json

Update Auth Settings

Updates authentication configuration.

patch
https://global.api.konghq.com/v2/authentication-settings

Body

application/json

The request schema to update an organization’s authentication settings.

basic_auth_enabledboolean

The organization has basic auth enabled.

Example:true

oidc_auth_enabledboolean

The organization has OIDC disabled.

Example:false

saml_auth_enabledboolean

The organization has SAML disabled.

Example:false

idp_mapping_enabledboolean

Whether IdP groups determine the Konnect teams a user has.

Example:true

konnect_mapping_enabledboolean

Whether a Konnect Identity Admin assigns teams to a user.

Example:false

Response

application/json

Response for authentication settings endpoint

basic_auth_enabledboolean

The organization has basic auth enabled.

Example:true

oidc_auth_enabledboolean

The organization has OIDC disabled.

Example:false

saml_auth_enabledboolean

The organization has SAML disabled.

Example:false

idp_mapping_enabledboolean

IdP groups determine the Konnect teams a user has.

Example:true

konnect_mapping_enabledboolean

A Konnect Identity Admin assigns teams to a user.

Example:false

patch/authentication-settings

Body

{ "oidc_auth_enabled": false, "saml_auth_enabled": false, "basic_auth_enabled": true, "idp_mapping_enabled": false, "konnect_mapping_enabled": true }
 
application/json

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