AppAuthStrategyOpenIDConnectResponse

object

Response payload from creating an OIDC Application Auth Strategy

* Additional properties are NOT allowed.
idstring(uuid)required
org_idstring(uuid)required
namestringrequired

The name of the app auth strategy.

>= 1 characters<= 256 characters

display_namestringrequired

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

<= 256 characters

strategy_typestringrequired

The stategy type. Can be either openid_connect or key_auth.

Allowed values:openid_connect

configsobjectrequired

JSON-B object containing the configuration for the OIDC strategy

* Additional properties are NOT allowed.
Show Child Parameters
dcr_providerobject
Show Child Parameters
labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

created_atstring(date-time)required
updated_atstring(date-time)required
Example

AppAuthStrategyKeyAuthResponse

object

Response payload from creating or updating a Key Auth Application Auth Strategy

* Additional properties are NOT allowed.
idstring(uuid)required
org_idstring(uuid)required
namestringrequired

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

>= 1 characters<= 256 characters

display_namestringrequired

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

<= 256 characters

strategy_typestringrequired

Allowed values:key_auth

configsobjectrequired

JSON-B object containing the configuration for the Key Auth strategy

* Additional properties are NOT allowed.
Show Child Parameters
labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

dcr_providerobject
Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required
Example

AppAuthStrategyConfigKeyAuth

object

The most basic mode to configure an Application Auth Strategy for an API Product Version.
Using this mode will allow developers to generate API keys that will authenticate their application requests.
Once authenticated, an application will be granted access to any Product Version it is registered for that is configured for Key Auth.

* Additional properties are NOT allowed.
key_namesarray[string]

The names of the headers containing the API key. You can specify multiple header names.

<= 256 characters>= 1 items<= 10 items

ttlobject

Default maximum Time-To-Live for keys created under this strategy.

Show Child Parameters
Example

AppAuthStrategyConfigOpenIDConnect

object

A more advanced mode to configure an API Product Version’s Application Auth Strategy.
Using this mode will allow developers to use API credentials issued from an external IdP that will authenticate their application requests.
Once authenticated, an application will be granted access to any Product Version it is registered for that is configured for the same Auth Strategy.
An OIDC strategy may be used in conjunction with a DCR provider to automatically create the IdP application.

* Additional properties are allowed.
issuerstring(url)required

<= 256 characters

credential_claimarray[string]required

<= 128 characters<= 10 items

scopesarray[string]required

<= 128 characters<= 50 items

auth_methodsarray[string]required

<= 64 characters<= 10 items

Example

ApiIds

object
api_idsarray[string](uuid)required
Example