How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Auth Settings API

The Auth Settings API from Kong — 8 operation(s) for auth settings.

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.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

17 operations 8 paths 40 schemas 2 DELETE8 GET4 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Auth Settings API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

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.

Auth Settings 17
GET
/v3/authentication-settings
Get Auth Settings
get-authentication-settings → 200401
PATCH
/v3/authentication-settings
Update Auth Settings
update-authentication-settings body → 200400401403
GET
/v3/identity-provider
Get the IdP Configuration
get-idp-configuration → 200400401403404
PATCH
/v3/identity-provider
Update IdP Configuration
update-idp-configuration body → 200400401403
GET
/v3/identity-provider/team-group-mappings
Get a Team Group Mappings
get-team-group-mappings 2 params → 200400401403
PATCH
/v3/identity-provider/team-group-mappings
Patch Mappings by Team ID
patch-team-group-mappings body → 200400401403
PUT
/v3/identity-provider/team-mappings
Update Team Mappings
update-idp-team-mappings body → 200400401404412
GET
/v3/identity-provider/team-mappings
Get a Team Mapping
get-idp-team-mappings 2 params → 200401403404412
GET
/v3/identity-providers
List Identity Providers
get-identity-providers 1 param → 200401403
POST
/v3/identity-providers
Create Identity Provider
create-identity-provider body → 201400401403409
GET
/v3/identity-providers/{id}
Get Identity Provider
get-identity-provider 1 param → 200400401403404
PATCH
/v3/identity-providers/{id}
Update Identity Provider
update-identity-provider 1 param body → 200400401403404409
DELETE
/v3/identity-providers/{id}
Delete Identity Provider
delete-identity-provider 1 param → 204400401403404
GET
/v3/identity-providers/{idpId}/team-group-mappings
List Team Group Mappings
list-idp-team-group-mappings 5 params → 200400401403404
POST
/v3/identity-providers/{idpId}/team-group-mappings
Create Team Group Mapping
create-idp-team-group-mapping 1 param body → 201400401403404409
GET
/v3/identity-providers/{idpId}/team-group-mappings/{id}
Get Team Group Mapping
get-idp-team-group-mapping 2 params → 200400401403404
DELETE
/v3/identity-providers/{idpId}/team-group-mappings/{id}
Delete Team Group Mapping
delete-idp-team-group-mapping 2 params → 204400401403404

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are IdentityProvider (7 properties), SAMLIdentityProviderConfig (6 properties), IdP (5 properties), IdpTeamGroupMapping (5 properties). Each schema is shown below with its type and property counts.

IdentityProviderLoginPath
string
The path used for initiating login requests with the identity provider.
BadRequestError
OIDCIdentityProviderConfig
object
The identity provider that contains configuration data for the OIDC authentication integration.
5 properties 2 required
InvalidParameterMinimumLength
object
5 properties 4 required
BaseError
object
standard error
5 properties 4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
OIDCIdentityProviderIssuer
string
The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.
UUID
string
Contains a unique identifier used for this resource.
PaginatedMeta
object
returns the pagination information
1 property 1 required
CursorMetaPage
object
5 properties 3 required
OIDCIdentityProviderClaimMappings
object
Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
3 properties
SAMLIdentityProviderConfig
object
The identity provider that contains configuration data for the SAML authentication integration.
6 properties
UnauthorizedError
NotFoundError
IdpTeamGroupMapping
object
A mapping between a Konnect team and an identity provider group.
5 properties 5 required
IdentityProviderType
string
Specifies the type of identity provider.
IdentityProviderEnabled
boolean
Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.
InvalidParameterMaximumLength
object
5 properties 4 required
InvalidParameterStandard
object
4 properties 2 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
OIDCIdentityProviderScopes
array
The scopes requested by your application when authenticating with the identity provider.
OIDCIdentityProviderClientSecret
string
The Client Secret assigned to your application by the identity provider.
InvalidParameterChoiceItem
object
5 properties 4 required
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
InvalidParameters
array
invalid parameters
SAMLIdentityProviderMetadata
string
The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the idpmetadataurl field instead.
CursorMeta
object
Pagination metadata.
1 property 1 required
ForbiddenError
ConflictError
IdentityProvider
object
The identity provider that contains configuration data for authentication integration.
7 properties
UpdateIdentityProvider
object
The identity provider that contains configuration data for updating an authentication integration.
3 properties
InvalidParameterDependentItem
object
5 properties 4 required
StringFieldEqualsFilter
object
Filters on the given string field value by exact match.
1 property
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
CreateIdentityProvider
object
The identity provider that contains configuration data for creating an authentication integration.
4 properties
SAMLIdentityProviderMetadataURL
string
The identity provider's metadata URL where the identity provider's metadata can be obtained.
InvalidRules
string
invalid parameters rules
OIDCIdentityProviderClientId
string
The client ID assigned to your application by the identity provider.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-auth-settings-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API
Where this information came from

This is an independent, third-party profile of Kong Auth Settings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.