Create App Auth Strategy
Creates an application auth strategy.
Body
application/json
Body
CreateAppAuthStrategyRequest
Request body for creating an Application Auth Strategy
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.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Response
application/json
Response
A response containing the newly created application auth strategy object.
CreateAppAuthStrategyResponse
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 OfContains 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
Body
List App Auth Strategies
Returns a paginated collection of application auth strategies.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Sorts a collection of application auth strategies. Supported sort attributes are:
- created_at
- updated_at
- strategy_type
- name
- display_name
- dcr_provider_id
- dcr_provider_name
- dcr_provider_type
Filter application auth strategies returned in the response.
Show Child Parameters
Response
application/json
Response
A paginated list response for a collection of application auth strategies.
ListAppAuthStrategiesResponse
A paginated list response for a collection of Application Auth Strategies
One OfA 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.
Response payload from creating or updating a Key Auth Application Auth Strategy
Show Child Parameters
returns the pagination information
Show Child Parameters
Query Parameters
Get App Auth Strategy
Returns an application auth strategy.
Path Parameters
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
A response containing a single application auth strategy object.
GetAppAuthStrategyResponse
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 OfContains 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
Path Parameters
Replace App Auth Strategy
Replaces an application auth strategy.
Path Parameters
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
CreateAppAuthStrategyRequest
Request body for creating an Application Auth Strategy
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.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Response
application/json
Response
A response containing the newly created application auth strategy object.
CreateAppAuthStrategyResponse
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 OfContains 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
Path Parameters
Body
Update App Auth Strategy
Updates an application auth strategy.
Path Parameters
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
UpdateAppAuthStrategyRequest
Request body for updating an 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
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"}
One OfJSON-B object containing the configuration for the OIDC strategy under the key ‘openid-connect’ or the configuration for the Key Auth strategy under the key ‘key-auth’
Show Child Parameters
Response
application/json
Response
A response containing a single updated application auth strategy object.
UpdateAppAuthStrategyResponse
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 OfContains 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