Kong Integration Instance Auth Config API
A integration instance may need to be provided with an auth config before authorizing the instance.Typically an auth config will be required when authorizing against a integration which is hosted within your organization.The integration instance's auth config will inform how the Service Catalog will authorize the integration instance.Note that updating the auth config for an instance which is already authorized will **remove the existing credential**, requiring you to re-authorize the instance.
Kong Integration Instance Auth Config 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 Integration Instance Auth Config. 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 3 operations across 1 path, and defines 16 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 Integration Instance Auth Config 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 3
Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
A integration instance may need to be provided with an auth config before authorizing the instance. Typically an auth config will be required when authorizing against a integratio…
Schemas 16
The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are InvalidParameterMinimumLength (5 properties), BaseError (5 properties), UpsertOAuthAuthConfig (5 properties), InvalidParameterMaximumLength (5 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.