PartialAppAuthStrategyConfigKeyAuth

object

Key Auth configuration for updating an Application Auth Strategy.
The ttl field can be set to null to unset the Time-To-Live.

* 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. Set to null to unset.

Show Child Parameters
Example

PartialAppAuthStrategyConfigOpenIDConnect

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)

<= 256 characters

credential_claimarray[string]

<= 128 characters<= 10 items

scopesarray[string]

<= 128 characters<= 50 items

auth_methodsarray[string]

<= 64 characters<= 10 items

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

AppAuthStrategyKeyAuthRequest

object

Request for creating a Key Auth Application Auth Strategy

* Additional properties are NOT allowed.
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
labelsobject

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"}

Example

AppAuthStrategyKeyAuthResponse

object

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

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

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
activebooleanrequired

At least one published entity is using this auth strategy.

dcr_providerobjectrequired
* 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.

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

Example:{"env":"test"}

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

supports_multiple_credentialsbooleanread-only

Indicates whether this auth strategy supports multiple credentials.
Always true for KEY_AUTH.

Default:true

Example