Auth Settings

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/v3/authentication-settings

Response

application/json

Response for authentication settings endpoint

Authentication Settings Response

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/v3/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

Authentication Settings Response

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

List Identity Providers

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

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

Query Parameters

filterobject

Filter identity providers returned in the response.

Show Child Parameters

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

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
 
application/json

Create Identity Provider

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

post
https://global.api.konghq.com/v3/identity-providers

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.

Create Identity Provider

The identity provider that contains configuration data for creating an authentication integration.

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

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

post/identity-providers

Body

{ "type": "oidc", "login_path": "the-oidc-konnect-org", "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