VirtualClusterAuthenticationPrincipal
objectA principal for authentication containing username and password.
A literal value or a reference to an existing secret as a template string expression.
The value is stored and returned by the API as-is, not treated as sensitive information.
>= 1 characters
A sensitive value containing the secret or a reference to a secret as a template string expression.
If the value is provided as plain text, it is encrypted at rest and omitted from API responses.
If provided as an expression, the expression itself is stored and returned by the API.
>= 1 characters
Example:${vault.env['MY_ENV_VAR']}
VirtualClusterAuthenticationJWKS
objectJSON Web Key Set configuration for verifying token signatures.
URL for JWKS endpoint.
>= 1 characters
Total time from establishing connection to receive a response from JWKS endpoint.
Default:10s
Duration after which the gateway will fetch and cache JWKS.
Default:1h
VirtualClusterAuthenticationClaimsMapping
objectMaps JWT claims in the case when sub and scope are presented as different claims in your JWT token.
Maps the subject claim.
>= 1 characters
Maps the scope claim.
>= 1 characters
VirtualClusterAuthenticationSaslScram
objectSASL/SCRAM authentication scheme for the virtual cluster.
Allowed values:sasl_scram
The algorithm used for SASL/SCRAM authentication.
Allowed values:sha256sha512
VirtualClusterAuthenticationOauthBearer
objectOauth Bearer authentication scheme for the virtual cluster.
Allowed values:oauth_bearer
Methods to mediate authentication:
- passthrough - pass authentication from the client through proxy to the backend cluster without any kind of
validation - validate_forward - pass authentication from the client through proxy to the backend cluster.
Proxy does the validation before forwarding it to the client. - terminate - terminate authentication at the proxy level and originate authentication to the backend cluster
using the configuration defined at BackendCluster’s authentication.
SASL auth is not originated if authentication on the backend_cluster is not configured.
Allowed values:passthroughvalidate_forwardterminate
Maps JWT claims in the case when sub and scope are presented as different claims in your JWT token.
Show Child Parameters
JSON Web Key Set configuration for verifying token signatures.
Show Child Parameters
Validation rules.