VirtualClusterAuthenticationOauthBearer

object

Oauth Bearer authentication scheme for the virtual cluster.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:oauth_bearer

mediationstringrequired

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

claims_mappingobject

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

Show Child Parameters
jwksobject

JSON Web Key Set configuration for verifying token signatures.

Show Child Parameters
validateobject

Validation rules.

Show Child Parameters
Example

VirtualClusterAuthenticationValidate

object

Validation rules.

audiencesarray[object]

List of expected audience values. One of them has to match the audience claim in the token.

>= 1 items

Show Child Parameters
issuerstring

Expected token issuer in the token.

>= 1 characters

Example

VirtualClusterAuthenticationAudience

object
namestringrequired

>= 1 characters

Example

VirtualClusterDNSLabel

string

The DNS label used in the bootstrap server URL to identify the virtual cluster when using SNI routing.
The format follows the RFC1035: 1-63 chars, lowercase alphanumeric or ‘-’, must start and end with an alphanumeric character.

Match pattern:^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

>= 1 characters<= 63 characters

Example

VirtualClusterACLMode

string

Configures whether or not ACL policies are enforced on the gateway.

  • enforce_on_gateway means the gateway enforces its own ACL policies for this virtual cluster
    and does not forward ACL-related commands to the backend cluster.
    Note that if there are no ACL policies configured, all access is denied.
  • passthrough tells the gateway to forward all ACL-related commands.

Allowed values:enforce_on_gatewaypassthrough