Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Impersonation Settings API

The Impersonation Settings API from Kong — 1 operation(s) for impersonation settings.

Kong Impersonation 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 Impersonation 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 2 operations across 1 path, and defines 11 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}.

2 operations 1 paths 11 schemas 1 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong Impersonation 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 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Impersonation Settings 2
GET
/v3/organizations/impersonation
Get Impersonation Settings
get-impersonation-settings → 200401404
PATCH
/v3/organizations/impersonation
Update Impersonation Settings
update-impersonation-settings body → 200400401403404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are InvalidParameterMaximumLength (5 properties), InvalidParameterMinimumLength (5 properties), InvalidParameterDependentItem (5 properties), BaseError (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
UnauthorizedError
InvalidRules
string
invalid parameters rules
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
InvalidParameters
array
invalid parameters
BadRequestError
NotFoundError
InvalidParameterStandard
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-impersonation-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