- Server 1:https://us.api.konghq.com
United-States Production region
- Server 2:https://eu.api.konghq.com
Europe Production region
- Server 3:https://au.api.konghq.com
Australia Production region
- Server 4:https://me.api.konghq.com
Middle-East Production region
- Server 5:https://in.api.konghq.com
India Production region
- Server 6:https://sg.api.konghq.com
Singapore Production region
Fetch a principal from a directory
Retrieves a principal from the specified directory by a key/value lookup.
Used by the data plane to resolve a principal during request processing.
Accepts either a binary Cap’n Proto payload or a JSON payload.
Path Parameters
Name of the targeted directory
Body
Body
Lookup payload to fetch a principal from the directory by a key/value pair.
Accepts either a binary Cap’n Proto payload or a JSON payload.
Schema definition for binary format: https://github.com/kong-konnect/sliver/blob/main/capnp/fetchprincipal.capnp
FetchPrincipalRequestPayload
The request payload used to look up a principal by a specific identity.
One OfThe identity used to look up a principal. The type field determines the identity kind and the required fields.
Looks up a principal by matching an OIDC claim name and value.
Show Child Parameters
When true, the Kong consumer identity mapped to the resolved principal is included in the response.
Scopes the consumer lookup to a specific workspace within the control plane. Applicable only when include_consumer is true.
Response
Response
The principal was found and returned successfully.
FetchPrincipalResponse
Response returned after a successful fetch-principal operation.
Wraps the resolved principal with cache control metadata.
A principal resolved from the directory. Contains the principal’s identity and metadata.
Show Child Parameters
Time in seconds the data plane should cache this result.
The Kong consumer associated with the resolved principal in the given control plane and workspace context.
Show Child Parameters
Path Parameters
Body
Authenticate on this directory
Authenticates a credential against the specified directory and returns the resolved principal.
Supports API key and basic auth credential types.
Accepts either a binary Cap’n Proto payload or a JSON payload.
Path Parameters
Name of the targeted directory
Body
Body
Credential payload to authenticate against the directory.
Accepts either a binary Cap’n Proto payload or a JSON payload.
Schema definition for binary format: https://github.com/kong-konnect/sliver/blob/main/capnp/authrequest.capnp
AuthenticateRequestPayload
The credential payload used to authenticate a request against the directory.
Use API key authentication to authenticate with an API key, or basic auth to authenticate with a username and password.
One Ofthe key to authenticate the principal with.
>= 1 characters
Allowed values:key_auth
When true, the Kong consumer identity mapped to the resolved principal is included in the response.
Scopes the consumer lookup to a specific workspace within the control plane. Applicable only when include_consumer is true.
Response
Response
Authentication succeeded and the principal was resolved.
AuthResponse
Response returned after a successful authentication operation.
Wraps the resolved principal with cache control metadata.
A principal resolved from the directory. Contains the principal’s identity and metadata.
Show Child Parameters
Time in seconds the data plane should cache this authentication result.
The unique identifier of the authenticated credential (API key or basic auth).
The Kong consumer associated with the resolved principal in the given control plane and workspace context.
Show Child Parameters
Path Parameters
Body
AuthenticateRequestPayload
objectThe credential payload used to authenticate a request against the directory.
Use API key authentication to authenticate with an API key, or basic auth to authenticate with a username and password.
One Ofthe key to authenticate the principal with.
>= 1 characters
Allowed values:key_auth
When true, the Kong consumer identity mapped to the resolved principal is included in the response.
Scopes the consumer lookup to a specific workspace within the control plane. Applicable only when include_consumer is true.