Application Auth Strategies are sets 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.
Kong App Auth Strategies API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include App Auth Strategies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.
This API exposes
6 operations
across 2 paths,
and defines 42 schemas.
It is described by OpenAPI 3.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
6 operations2 paths42 schemas1 DELETE2 GET1 PATCH1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Kong App Auth Strategies API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Kong-Admin-Token (adminToken).
By default, every request must be authenticated.
Paths & Operations 6
Across 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
App Auth Strategies 6
Application Auth Strategies are sets of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version. Called “Auth Stra…
The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are AppAuthStrategyKeyAuthResponse (11 properties), AppAuthStrategyOpenIDConnectResponse (11 properties), AppAuthStrategyOpenIDConnectRequest (6 properties), InvalidParameterDependentItem (5 properties). Each schema is shown below with its type and property counts.
InvalidParameterMinimumLength
object
5 properties4 required
UpdateAppAuthStrategyRequest
object
Request body for updating an Application Auth Strategy
5 properties
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
AuthStrategyName
string
The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.
ConflictError
InvalidParameterChoiceItem
object
5 properties4 required
InvalidParameterMaximumLength
object
5 properties4 required
AppAuthStrategyKeyAuthRequest
object
Request for creating a Key Auth Application Auth Strategy
5 properties4 required
AppAuthStrategyConfigKeyAuth
object
The 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…
2 properties
ListAppAuthStrategiesResponse
object
A paginated list response for a collection of Application Auth Strategies
2 properties2 required
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
AuthStrategyDisplayName
string
The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.
UUID
string
Contains a unique identifier used for this resource.
AppAuthStrategy
object
A set of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version. Called “Auth Strategy” for s…
1 required
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.
2 properties
Labels
object
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,…
ForbiddenError
UnauthorizedError
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…
4 properties
LabelsUpdate
object
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 me…
PaginatedMeta
object
returns the pagination information
1 property1 required
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
GetAppAuthStrategyResponse
CreateAppAuthStrategyRequest
object
Request body for creating an Application Auth Strategy
1 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
DcrProviderDisplayName
string
The display name of the DCR provider. This is used to identify the DCR provider in the Portal UI.
BaseError
object
standard error
5 properties4 required
AppAuthStrategyKeyAuthResponse
object
Response payload from creating or updating a Key Auth Application Auth Strategy
11 properties10 required
InvalidParameterDependentItem
object
5 properties4 required
InvalidRules
string
invalid parameters rules
UpdateAppAuthStrategyRequestOpenIdConnect
object
1 property1 required
InvalidParameters
array
invalid parameters
BadRequestError
UpdateAppAuthStrategyRequestKeyAuth
object
1 property1 required
InvalidParameterStandard
object
4 properties2 required
CreateAppAuthStrategyResponse
UpdateAppAuthStrategyResponse
AppAuthStrategyOpenIDConnectRequest
object
Payload for creating an OIDC Application Auth Strategy
6 properties4 required
AppAuthStrategyOpenIDConnectResponse
object
Response payload from creating an OIDC Application Auth Strategy
11 properties10 required
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…
4 properties4 required
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
