Kong Auth Settings 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 Auth Settings. 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
17 operations
across 8 paths,
and defines 40 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}.
17 operations8 paths40 schemas2 DELETE8 GET4 PATCH2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Kong Auth Settings 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 17
Across 8 paths, the API surfaces 17 operations — 2 DELETE, 8 GET, 4 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are IdentityProvider (7 properties), SAMLIdentityProviderConfig (6 properties), IdpTeamGroupMapping (5 properties), OIDCIdentityProviderConfig (5 properties). Each schema is shown below with its type and property counts.
IdentityProvider
object
The identity provider that contains configuration data for authentication integration.
7 properties
InvalidParameterMinimumLength
object
5 properties4 required
IdP
object
The IdP object contains the configuration data for the OIDC authentication integration. NOTE: The openid scope is required. Removing it could break the OIDC in…
5 properties
IdpTeamGroupMapping
object
A mapping between a Konnect team and an identity provider group.
5 properties5 required
SAMLIdentityProviderMetadata
string
The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the idpmetadataurl field instead.
StringFieldEqualsFilter
object
Filters on the given string field value by exact match.
1 property
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties4 required
ConflictError
InvalidParameterMaximumLength
object
5 properties4 required
OIDCIdentityProviderClaimMappings
object
Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
3 properties
OIDCIdentityProviderScopes
array
The scopes requested by your application when authenticating with the identity provider.
IdentityProviderLoginPath
string
The path used for initiating login requests with the identity provider.
UpdateIdentityProvider
object
The identity provider that contains configuration data for updating an authentication integration.
3 properties
CreateIdentityProvider
object
The identity provider that contains configuration data for creating an authentication integration.
4 properties
UUID
string
Contains a unique identifier used for this resource.
TeamMapping
object
A team assignment is a mapping of an IdP group to a Konnect Team.
2 properties
TeamGroupMapping
object
A map of Konnect Team to IdP groups.
2 properties
UnauthorizedError
CursorMetaPage
object
5 properties3 required
SAMLIdentityProviderMetadataURL
string
The identity provider's metadata URL where the identity provider's metadata can be obtained.
CursorMeta
object
Pagination metadata.
1 property1 required
ForbiddenError
OIDCIdentityProviderClientSecret
string
The Client Secret assigned to your application by the identity provider.
PaginatedMeta
object
returns the pagination information
1 property1 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties4 required
InvalidParameterDependentItem
object
5 properties4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
IdentityProviderEnabled
boolean
Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.
IdentityProviderType
string
Specifies the type of identity provider.
InvalidParameterStandard
object
4 properties2 required
SAMLIdentityProviderConfig
object
The identity provider that contains configuration data for the SAML authentication integration.
6 properties
OIDCIdentityProviderConfig
object
The identity provider that contains configuration data for the OIDC authentication integration.
5 properties2 required
OIDCIdentityProviderClientId
string
The client ID assigned to your application by the identity provider.
OIDCIdentityProviderIssuer
string
The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.
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.
