App Auth Strategies
List application auth strategies
Returns a list of application auth strategies with their id and active status.
Query Parameters
Filter parameters for filtering by ID
Show Child Parameters
Response
application/json
Response
A response containing a list of application auth strategies with their status.
Active Response
The list of items with their active status
The item with id and active status
Show Child Parameters
Query Parameters
Upsert an application auth strategy
Accepts a raw database representation of the Auth Strategy in the request body.
Accepts a raw database representation of the DCR provider (if provided) in the response body.
Path Parameters
ID of the auth strategy to use for the application
Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79
Body
application/json
Body
AppAuthStrategy
A 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
Response
application/json
Response
A response containing a single DCR provider object.
AppAuthStrategy
A 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
Path Parameters
Body
Deletes an application auth strategy.
Deletes the Auth Strategy.
Path Parameters
ID of the auth strategy to use for the application
Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79
Response
Response
No Content.