AuthResponse
objectResponse 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
FetchPrincipalResponse
objectResponse 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
ConsumerIdentity
objectThe Kong consumer associated with the resolved principal in the given control plane and workspace context.
The unique identifier of the Kong consumer.
The Kong control plane this consumer belongs to.
The workspace within the control plane, if applicable.
Principal
objectA principal resolved from the directory. Contains the principal’s identity and metadata.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Human-readable name of the principal.
A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane
to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical
manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
UnauthorizedError
The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.
Example:401
A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.
Example:Unauthorized
The error type.
Example:https://httpstatuses.com/401
Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.
Example:kong:trace:1234567890
A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.
Example:Invalid credentials
Time in seconds the data plane should cache this authentication failure.
Mirrors the directory-level negative_ttl_secs setting.
Zero means no caching hint.