AuthResponse

object

Response returned after a successful authentication operation.
Wraps the resolved principal with cache control metadata.

principalobjectrequired

A principal resolved from the directory. Contains the principal’s identity and metadata.

Show Child Parameters
ttl_secsintegerrequired

Time in seconds the data plane should cache this authentication result.

credential_idstring(uuid)required

The unique identifier of the authenticated credential (API key or basic auth).

consumerobject

The Kong consumer associated with the resolved principal in the given control plane and workspace context.

Show Child Parameters
Example

FetchPrincipalResponse

object

Response returned after a successful fetch-principal operation.
Wraps the resolved principal with cache control metadata.

principalobjectrequired

A principal resolved from the directory. Contains the principal’s identity and metadata.

Show Child Parameters
ttl_secsintegerrequired

Time in seconds the data plane should cache this result.

consumerobject

The Kong consumer associated with the resolved principal in the given control plane and workspace context.

Show Child Parameters
Example

ConsumerIdentity

object

The Kong consumer associated with the resolved principal in the given control plane and workspace context.

idstringrequired

The unique identifier of the Kong consumer.

control_plane_idstringrequired

The Kong control plane this consumer belongs to.

workspace_idstring

The workspace within the control plane, if applicable.

Example

Principal

object

A principal resolved from the directory. Contains the principal’s identity and metadata.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

display_namestringrequired

Human-readable name of the principal.

metadataobjectrequired

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.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

UnauthorizedError

statusintegerrequiredread-only

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

titlestringrequiredread-only

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

typestringread-only

The error type.

Example:https://httpstatuses.com/401

instancestringrequiredread-only

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

detailstringrequiredread-only

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

negative_ttl_secsintegerrequired

Time in seconds the data plane should cache this authentication failure.
Mirrors the directory-level negative_ttl_secs setting.
Zero means no caching hint.

Example