FetchPrincipalRequestPayload
objectThe 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.
FetchBy
The identity used to look up a principal. The type field determines the identity kind and the required fields.
One OfAllowed values:oidc
The OIDC issuer URL that issued the claims.
>= 1 characters
Show Child Parameters
FetchByOIDC
objectLooks up a principal by matching an OIDC claim name and value.
Allowed values:oidc
The OIDC issuer URL that issued the claims.
>= 1 characters
Show Child Parameters
FetchByPrincipalID
objectLooks up a principal by its unique principal ID.
Allowed values:principal_id
The unique identifier of the principal to fetch.
FetchByConsumer
objectLooks up a principal by a Kong consumer ID for the requesting control-plane.
Allowed values:consumer
The unique identifier of the Kong consumer.
>= 1 characters
The workspace ID within the control plane.