public static final class JwtAuthentication.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder> implements JwtAuthenticationOrBuilder
This is the Envoy HTTP filter config for JWT authentication.
For example:
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: issuer2
local_jwks:
inline_string: jwks_string
rules:
# Not jwt verification is required for /health path
- match:
prefix: /health
# Jwt verification for provider1 is required for path prefixed with "prefix"
- match:
prefix: /prefix
requires:
provider_name: provider1
# Jwt verification for either provider1 or provider2 is required for all other requests.
- match:
prefix: /
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
Protobuf type envoy.config.filter.http.jwt_authn.v2alpha.JwtAuthentication| Modifier and Type | Method and Description |
|---|---|
JwtAuthentication.Builder |
addAllRules(Iterable<? extends RequirementRule> values)
Specifies requirements based on the route matches.
|
JwtAuthentication.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
JwtAuthentication.Builder |
addRules(int index,
RequirementRule.Builder builderForValue)
Specifies requirements based on the route matches.
|
JwtAuthentication.Builder |
addRules(int index,
RequirementRule value)
Specifies requirements based on the route matches.
|
JwtAuthentication.Builder |
addRules(RequirementRule.Builder builderForValue)
Specifies requirements based on the route matches.
|
JwtAuthentication.Builder |
addRules(RequirementRule value)
Specifies requirements based on the route matches.
|
RequirementRule.Builder |
addRulesBuilder()
Specifies requirements based on the route matches.
|
RequirementRule.Builder |
addRulesBuilder(int index)
Specifies requirements based on the route matches.
|
JwtAuthentication |
build() |
JwtAuthentication |
buildPartial() |
JwtAuthentication.Builder |
clear() |
JwtAuthentication.Builder |
clearBypassCorsPreflight()
When set to true, bypass the `CORS preflight request
<http://www.w3.org/TR/cors/#cross-origin-request-with-preflight>`_ regardless of JWT
requirements specified in the rules.
|
JwtAuthentication.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
JwtAuthentication.Builder |
clearFilterStateRules()
This message specifies Jwt requirements based on stream_info.filterState.
|
JwtAuthentication.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
JwtAuthentication.Builder |
clearProviders() |
JwtAuthentication.Builder |
clearRules()
Specifies requirements based on the route matches.
|
JwtAuthentication.Builder |
clone() |
boolean |
containsProviders(String key)
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1; |
boolean |
getBypassCorsPreflight()
When set to true, bypass the `CORS preflight request
<http://www.w3.org/TR/cors/#cross-origin-request-with-preflight>`_ regardless of JWT
requirements specified in the rules.
|
JwtAuthentication |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
FilterStateRule |
getFilterStateRules()
This message specifies Jwt requirements based on stream_info.filterState.
|
FilterStateRule.Builder |
getFilterStateRulesBuilder()
This message specifies Jwt requirements based on stream_info.filterState.
|
FilterStateRuleOrBuilder |
getFilterStateRulesOrBuilder()
This message specifies Jwt requirements based on stream_info.filterState.
|
Map<String,JwtProvider> |
getMutableProviders()
Deprecated.
|
Map<String,JwtProvider> |
getProviders()
Deprecated.
|
int |
getProvidersCount()
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1; |
Map<String,JwtProvider> |
getProvidersMap()
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1; |
JwtProvider |
getProvidersOrDefault(String key,
JwtProvider defaultValue)
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1; |
JwtProvider |
getProvidersOrThrow(String key)
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1; |
RequirementRule |
getRules(int index)
Specifies requirements based on the route matches.
|
RequirementRule.Builder |
getRulesBuilder(int index)
Specifies requirements based on the route matches.
|
List<RequirementRule.Builder> |
getRulesBuilderList()
Specifies requirements based on the route matches.
|
int |
getRulesCount()
Specifies requirements based on the route matches.
|
List<RequirementRule> |
getRulesList()
Specifies requirements based on the route matches.
|
RequirementRuleOrBuilder |
getRulesOrBuilder(int index)
Specifies requirements based on the route matches.
|
List<? extends RequirementRuleOrBuilder> |
getRulesOrBuilderList()
Specifies requirements based on the route matches.
|
boolean |
hasFilterStateRules()
This message specifies Jwt requirements based on stream_info.filterState.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
protected com.google.protobuf.MapField |
internalGetMutableMapField(int number) |
boolean |
isInitialized() |
JwtAuthentication.Builder |
mergeFilterStateRules(FilterStateRule value)
This message specifies Jwt requirements based on stream_info.filterState.
|
JwtAuthentication.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
JwtAuthentication.Builder |
mergeFrom(JwtAuthentication other) |
JwtAuthentication.Builder |
mergeFrom(com.google.protobuf.Message other) |
JwtAuthentication.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
JwtAuthentication.Builder |
putAllProviders(Map<String,JwtProvider> values)
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1; |
JwtAuthentication.Builder |
putProviders(String key,
JwtProvider value)
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1; |
JwtAuthentication.Builder |
removeProviders(String key)
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1; |
JwtAuthentication.Builder |
removeRules(int index)
Specifies requirements based on the route matches.
|
JwtAuthentication.Builder |
setBypassCorsPreflight(boolean value)
When set to true, bypass the `CORS preflight request
<http://www.w3.org/TR/cors/#cross-origin-request-with-preflight>`_ regardless of JWT
requirements specified in the rules.
|
JwtAuthentication.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
JwtAuthentication.Builder |
setFilterStateRules(FilterStateRule.Builder builderForValue)
This message specifies Jwt requirements based on stream_info.filterState.
|
JwtAuthentication.Builder |
setFilterStateRules(FilterStateRule value)
This message specifies Jwt requirements based on stream_info.filterState.
|
JwtAuthentication.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
JwtAuthentication.Builder |
setRules(int index,
RequirementRule.Builder builderForValue)
Specifies requirements based on the route matches.
|
JwtAuthentication.Builder |
setRules(int index,
RequirementRule value)
Specifies requirements based on the route matches.
|
JwtAuthentication.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>protected com.google.protobuf.MapField internalGetMutableMapField(int number)
internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>public JwtAuthentication.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>public JwtAuthentication getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic JwtAuthentication build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic JwtAuthentication buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic JwtAuthentication.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>public JwtAuthentication.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>public JwtAuthentication.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>public JwtAuthentication.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>public JwtAuthentication.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>public JwtAuthentication.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>public JwtAuthentication.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<JwtAuthentication.Builder>public JwtAuthentication.Builder mergeFrom(JwtAuthentication other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>public JwtAuthentication.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<JwtAuthentication.Builder>IOExceptionpublic int getProvidersCount()
JwtAuthenticationOrBuilder
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;getProvidersCount in interface JwtAuthenticationOrBuilderpublic boolean containsProviders(String key)
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;containsProviders in interface JwtAuthenticationOrBuilder@Deprecated public Map<String,JwtProvider> getProviders()
getProvidersMap() instead.getProviders in interface JwtAuthenticationOrBuilderpublic Map<String,JwtProvider> getProvidersMap()
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;getProvidersMap in interface JwtAuthenticationOrBuilderpublic JwtProvider getProvidersOrDefault(String key, JwtProvider defaultValue)
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;getProvidersOrDefault in interface JwtAuthenticationOrBuilderpublic JwtProvider getProvidersOrThrow(String key)
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;getProvidersOrThrow in interface JwtAuthenticationOrBuilderpublic JwtAuthentication.Builder clearProviders()
public JwtAuthentication.Builder removeProviders(String key)
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;@Deprecated public Map<String,JwtProvider> getMutableProviders()
public JwtAuthentication.Builder putProviders(String key, JwtProvider value)
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;public JwtAuthentication.Builder putAllProviders(Map<String,JwtProvider> values)
Map of provider names to JwtProviders.
.. code-block:: yaml
providers:
provider1:
issuer: issuer1
audiences:
- audience1
- audience2
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
provider2:
issuer: provider2
local_jwks:
inline_string: jwks_string
map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;public List<RequirementRule> getRulesList()
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;getRulesList in interface JwtAuthenticationOrBuilderpublic int getRulesCount()
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;getRulesCount in interface JwtAuthenticationOrBuilderpublic RequirementRule getRules(int index)
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;getRules in interface JwtAuthenticationOrBuilderpublic JwtAuthentication.Builder setRules(int index, RequirementRule value)
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public JwtAuthentication.Builder setRules(int index, RequirementRule.Builder builderForValue)
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public JwtAuthentication.Builder addRules(RequirementRule value)
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public JwtAuthentication.Builder addRules(int index, RequirementRule value)
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public JwtAuthentication.Builder addRules(RequirementRule.Builder builderForValue)
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public JwtAuthentication.Builder addRules(int index, RequirementRule.Builder builderForValue)
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public JwtAuthentication.Builder addAllRules(Iterable<? extends RequirementRule> values)
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public JwtAuthentication.Builder clearRules()
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public JwtAuthentication.Builder removeRules(int index)
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public RequirementRule.Builder getRulesBuilder(int index)
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public RequirementRuleOrBuilder getRulesOrBuilder(int index)
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;getRulesOrBuilder in interface JwtAuthenticationOrBuilderpublic List<? extends RequirementRuleOrBuilder> getRulesOrBuilderList()
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;getRulesOrBuilderList in interface JwtAuthenticationOrBuilderpublic RequirementRule.Builder addRulesBuilder()
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public RequirementRule.Builder addRulesBuilder(int index)
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public List<RequirementRule.Builder> getRulesBuilderList()
Specifies requirements based on the route matches. The first matched requirement will be
applied. If there are overlapped match conditions, please put the most specific match first.
Examples
.. code-block:: yaml
rules:
- match:
prefix: /healthz
- match:
prefix: /baz
requires:
provider_name: provider1
- match:
prefix: /foo
requires:
requires_any:
requirements:
- provider_name: provider1
- provider_name: provider2
- match:
prefix: /bar
requires:
requires_all:
requirements:
- provider_name: provider1
- provider_name: provider2
repeated .envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;public boolean hasFilterStateRules()
This message specifies Jwt requirements based on stream_info.filterState. Other HTTP filters can use it to specify Jwt requirements dynamically. The *rules* field above is checked first, if it could not find any matches, check this one.
.envoy.config.filter.http.jwt_authn.v2alpha.FilterStateRule filter_state_rules = 3;hasFilterStateRules in interface JwtAuthenticationOrBuilderpublic FilterStateRule getFilterStateRules()
This message specifies Jwt requirements based on stream_info.filterState. Other HTTP filters can use it to specify Jwt requirements dynamically. The *rules* field above is checked first, if it could not find any matches, check this one.
.envoy.config.filter.http.jwt_authn.v2alpha.FilterStateRule filter_state_rules = 3;getFilterStateRules in interface JwtAuthenticationOrBuilderpublic JwtAuthentication.Builder setFilterStateRules(FilterStateRule value)
This message specifies Jwt requirements based on stream_info.filterState. Other HTTP filters can use it to specify Jwt requirements dynamically. The *rules* field above is checked first, if it could not find any matches, check this one.
.envoy.config.filter.http.jwt_authn.v2alpha.FilterStateRule filter_state_rules = 3;public JwtAuthentication.Builder setFilterStateRules(FilterStateRule.Builder builderForValue)
This message specifies Jwt requirements based on stream_info.filterState. Other HTTP filters can use it to specify Jwt requirements dynamically. The *rules* field above is checked first, if it could not find any matches, check this one.
.envoy.config.filter.http.jwt_authn.v2alpha.FilterStateRule filter_state_rules = 3;public JwtAuthentication.Builder mergeFilterStateRules(FilterStateRule value)
This message specifies Jwt requirements based on stream_info.filterState. Other HTTP filters can use it to specify Jwt requirements dynamically. The *rules* field above is checked first, if it could not find any matches, check this one.
.envoy.config.filter.http.jwt_authn.v2alpha.FilterStateRule filter_state_rules = 3;public JwtAuthentication.Builder clearFilterStateRules()
This message specifies Jwt requirements based on stream_info.filterState. Other HTTP filters can use it to specify Jwt requirements dynamically. The *rules* field above is checked first, if it could not find any matches, check this one.
.envoy.config.filter.http.jwt_authn.v2alpha.FilterStateRule filter_state_rules = 3;public FilterStateRule.Builder getFilterStateRulesBuilder()
This message specifies Jwt requirements based on stream_info.filterState. Other HTTP filters can use it to specify Jwt requirements dynamically. The *rules* field above is checked first, if it could not find any matches, check this one.
.envoy.config.filter.http.jwt_authn.v2alpha.FilterStateRule filter_state_rules = 3;public FilterStateRuleOrBuilder getFilterStateRulesOrBuilder()
This message specifies Jwt requirements based on stream_info.filterState. Other HTTP filters can use it to specify Jwt requirements dynamically. The *rules* field above is checked first, if it could not find any matches, check this one.
.envoy.config.filter.http.jwt_authn.v2alpha.FilterStateRule filter_state_rules = 3;getFilterStateRulesOrBuilder in interface JwtAuthenticationOrBuilderpublic boolean getBypassCorsPreflight()
When set to true, bypass the `CORS preflight request <http://www.w3.org/TR/cors/#cross-origin-request-with-preflight>`_ regardless of JWT requirements specified in the rules.
bool bypass_cors_preflight = 4;getBypassCorsPreflight in interface JwtAuthenticationOrBuilderpublic JwtAuthentication.Builder setBypassCorsPreflight(boolean value)
When set to true, bypass the `CORS preflight request <http://www.w3.org/TR/cors/#cross-origin-request-with-preflight>`_ regardless of JWT requirements specified in the rules.
bool bypass_cors_preflight = 4;public JwtAuthentication.Builder clearBypassCorsPreflight()
When set to true, bypass the `CORS preflight request <http://www.w3.org/TR/cors/#cross-origin-request-with-preflight>`_ regardless of JWT requirements specified in the rules.
bool bypass_cors_preflight = 4;public final JwtAuthentication.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>public final JwtAuthentication.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>Copyright © 2018–2021 The Envoy Project. All rights reserved.