Kong Consumers API
The consumer object represents a consumer - or a user - of a service.You can either rely on Kong Gateway as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong Gateway and your existing primary datastore.
Kong Consumers 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 Consumers. 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 13 operations across 6 paths, and defines 6 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}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Kong Consumers 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 13
Across 6 paths, the API surfaces 13 operations — 4 DELETE, 4 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
The consumer object represents a consumer - or a user - of a service. You can either rely on Kong Gateway as the primary datastore, or you can map the consumer list with your data…
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Consumer (6 properties), Consumer_2 (6 properties), ConsumerGroup (5 properties), GatewayUnauthorizedError (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kong 12
Other APIs Kong publishes across the network.