VirtualClusterAuthenticationPrincipalSensitiveDataAware

object

A principal for authentication.

usernamestringrequired

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

passwordstring

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']}

Example

VirtualClusterAuthenticationPrincipal

object

A principal for authentication containing username and password.

usernamestringrequired

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

passwordstringrequired

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']}

Example

VirtualClusterAuthenticationJWKS

object

JSON Web Key Set configuration for verifying token signatures.

endpointstring(uri)required

URL for JWKS endpoint.

>= 1 characters

timeoutstring

Total time from establishing connection to receive a response from JWKS endpoint.

Default:10s

cache_expirationstring

Duration after which the gateway will fetch and cache JWKS.

Default:1h

Example

VirtualClusterAuthenticationClaimsMapping

object

Maps JWT claims in the case when sub and scope are presented as different claims in your JWT token.

substring

Maps the subject claim.

>= 1 characters

scopestring

Maps the scope claim.

>= 1 characters

Example

VirtualClusterAuthenticationSaslScram

object

SASL/SCRAM authentication scheme for the virtual cluster.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:sasl_scram

algorithmstringrequired

The algorithm used for SASL/SCRAM authentication.

Allowed values:sha256sha512

Example