PartialAppAuthStrategyConfigKeyAuth
objectKey Auth configuration for updating an Application Auth Strategy.
The ttl field can be set to null to unset the Time-To-Live.
The names of the headers containing the API key. You can specify multiple header names.
<= 256 characters>= 1 items<= 10 items
Default maximum Time-To-Live for keys created under this strategy. Set to null to unset.
Show Child Parameters
PartialAppAuthStrategyConfigOpenIDConnect
objectA 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.
<= 256 characters
<= 128 characters<= 10 items
<= 128 characters<= 50 items
<= 64 characters<= 10 items
AppAuthStrategyConfigOpenIDConnect
objectA 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.
<= 256 characters
<= 128 characters<= 10 items
<= 128 characters<= 50 items
<= 64 characters<= 10 items
AppAuthStrategyKeyAuthRequest
objectRequest for creating a Key Auth Application Auth Strategy
The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.
>= 1 characters<= 256 characters
The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.
<= 256 characters
Allowed values:key_auth
JSON-B object containing the configuration for the Key Auth strategy
Show Child Parameters
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"}
AppAuthStrategyKeyAuthResponse
objectResponse payload from creating or updating a Key Auth Application Auth Strategy
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.
>= 1 characters<= 256 characters
The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.
<= 256 characters
Allowed values:key_auth
JSON-B object containing the configuration for the Key Auth strategy
Show Child Parameters
At least one published entity is using this auth strategy.
Show Child Parameters
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"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Indicates whether this auth strategy supports multiple credentials.
Always true for KEY_AUTH.
Default:true