AuthenticateRequestPayloadKeyAuth

object

Authenticates a request using an API key credential.

api_keystringrequired

the key to authenticate the principal with.

>= 1 characters

auth_typestringrequired

Allowed values:key_auth

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

AuthenticateRequestPayloadBasicAuth

object

Authenticates a request using a username and password credential.

usernamestringrequired

The username of the principal to authenticate.

>= 1 characters

passwordstringrequired

The password associated with the username.

>= 1 characters

auth_typestringrequired

Allowed values:basic_auth

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

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