AppAuthStrategy
objectA set of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version. Called “Auth Strategy” for short in the context of portals/applications. The plugins are synced to any Gateway Service that is currently linked or becomes linked to the Product Version.
One OfThe 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.
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"}
Show Child Parameters
AppAuthStrategyOpenIDConnectResponse
objectResponse payload from creating an OIDC Application Auth Strategy
The name of the app auth strategy.
>= 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
The stategy type. Can be either openid_connect or key_auth.
Allowed values:openid_connect
JSON-B object containing the configuration for the OIDC strategy
Show Child Parameters
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
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.
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"}
Show Child Parameters
AppAuthStrategyConfigKeyAuth
objectThe 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.
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.
Show Child Parameters
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