FetchByPrincipalID

object

Looks up a principal by its unique principal ID.

typestringrequired

Allowed values:principal_id

principal_idstring(uuid)required

The unique identifier of the principal to fetch.

Example

FetchByConsumer

object

Looks up a principal by a Kong consumer ID for the requesting control-plane.

typestringrequired

Allowed values:consumer

consumer_idstringrequired

The unique identifier of the Kong consumer.

>= 1 characters

workspace_idstring

The workspace ID within the control plane.

Example

FetchByCustom

object

Looks up a principal by an arbitrary key/value pair.

typestringrequired

Allowed values:custom

keystringrequired

The custom key to match against.

>= 1 characters

valuestringrequired

The value of the identity to match against.

>= 1 characters

Example

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