FetchPrincipalRequestPayload

object

The request payload used to look up a principal by a specific identity.

fetch_byOne Of
required

The identity used to look up a principal. The type field determines the identity kind and the required fields.

FetchByOIDCobject

Looks up a principal by matching an OIDC claim name and value.

Show Child Parameters
include_consumerboolean

When true, the Kong consumer identity mapped to the resolved principal is included in the response.

workspace_idstring

Scopes the consumer lookup to a specific workspace within the control plane. Applicable only when include_consumer is true.

Example

FetchBy

The identity used to look up a principal. The type field determines the identity kind and the required fields.

One Of
typestringrequired

Allowed values:oidc

issuerstring(uri)required

The OIDC issuer URL that issued the claims.

>= 1 characters

claimobjectrequired
Show Child Parameters
Example

FetchByOIDC

object

Looks up a principal by matching an OIDC claim name and value.

typestringrequired

Allowed values:oidc

issuerstring(uri)required

The OIDC issuer URL that issued the claims.

>= 1 characters

claimobjectrequired
Show Child Parameters
Example

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