AuthenticateRequestPayload
objectThe credential payload used to authenticate a request against the directory.
Use API key authentication to authenticate with an API key, or basic auth to authenticate with a username and password.
One Ofthe key to authenticate the principal with.
>= 1 characters
Allowed values:key_auth
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.
AuthenticateRequestPayloadKeyAuth
objectAuthenticates a request using an API key credential.
the key to authenticate the principal with.
>= 1 characters
Allowed values:key_auth
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.
AuthenticateRequestPayloadBasicAuth
objectAuthenticates a request using a username and password credential.
The username of the principal to authenticate.
>= 1 characters
The password associated with the username.
>= 1 characters
Allowed values:basic_auth
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.
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