public static final class Config.JwtAuthentication.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtAuthentication.Builder> implements Config.JwtAuthenticationOrBuilder
This is the Envoy HTTP filter config for JWT authentication. [#not-implemented-hide:]Protobuf type
envoy.config.filter.http.jwt_authn.v2alpha.JwtAuthentication| Modifier and Type | Method and Description |
|---|---|
Config.JwtAuthentication.Builder |
addAllBypass(Iterable<? extends RouteOuterClass.RouteMatch> values)
This field lists the patterns allowed to bypass JWT verification.
|
Config.JwtAuthentication.Builder |
addAllRules(Iterable<? extends Config.JwtRule> values)
List of JWT rules to valide.
|
Config.JwtAuthentication.Builder |
addBypass(int index,
RouteOuterClass.RouteMatch.Builder builderForValue)
This field lists the patterns allowed to bypass JWT verification.
|
Config.JwtAuthentication.Builder |
addBypass(int index,
RouteOuterClass.RouteMatch value)
This field lists the patterns allowed to bypass JWT verification.
|
Config.JwtAuthentication.Builder |
addBypass(RouteOuterClass.RouteMatch.Builder builderForValue)
This field lists the patterns allowed to bypass JWT verification.
|
Config.JwtAuthentication.Builder |
addBypass(RouteOuterClass.RouteMatch value)
This field lists the patterns allowed to bypass JWT verification.
|
RouteOuterClass.RouteMatch.Builder |
addBypassBuilder()
This field lists the patterns allowed to bypass JWT verification.
|
RouteOuterClass.RouteMatch.Builder |
addBypassBuilder(int index)
This field lists the patterns allowed to bypass JWT verification.
|
Config.JwtAuthentication.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Config.JwtAuthentication.Builder |
addRules(Config.JwtRule.Builder builderForValue)
List of JWT rules to valide.
|
Config.JwtAuthentication.Builder |
addRules(Config.JwtRule value)
List of JWT rules to valide.
|
Config.JwtAuthentication.Builder |
addRules(int index,
Config.JwtRule.Builder builderForValue)
List of JWT rules to valide.
|
Config.JwtAuthentication.Builder |
addRules(int index,
Config.JwtRule value)
List of JWT rules to valide.
|
Config.JwtRule.Builder |
addRulesBuilder()
List of JWT rules to valide.
|
Config.JwtRule.Builder |
addRulesBuilder(int index)
List of JWT rules to valide.
|
Config.JwtAuthentication |
build() |
Config.JwtAuthentication |
buildPartial() |
Config.JwtAuthentication.Builder |
clear() |
Config.JwtAuthentication.Builder |
clearAllowMissingOrFailed()
If true, the request is allowed if JWT is missing or JWT verification fails.
|
Config.JwtAuthentication.Builder |
clearBypass()
This field lists the patterns allowed to bypass JWT verification.
|
Config.JwtAuthentication.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Config.JwtAuthentication.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Config.JwtAuthentication.Builder |
clearRules()
List of JWT rules to valide.
|
Config.JwtAuthentication.Builder |
clone() |
boolean |
getAllowMissingOrFailed()
If true, the request is allowed if JWT is missing or JWT verification fails.
|
RouteOuterClass.RouteMatch |
getBypass(int index)
This field lists the patterns allowed to bypass JWT verification.
|
RouteOuterClass.RouteMatch.Builder |
getBypassBuilder(int index)
This field lists the patterns allowed to bypass JWT verification.
|
List<RouteOuterClass.RouteMatch.Builder> |
getBypassBuilderList()
This field lists the patterns allowed to bypass JWT verification.
|
int |
getBypassCount()
This field lists the patterns allowed to bypass JWT verification.
|
List<RouteOuterClass.RouteMatch> |
getBypassList()
This field lists the patterns allowed to bypass JWT verification.
|
RouteOuterClass.RouteMatchOrBuilder |
getBypassOrBuilder(int index)
This field lists the patterns allowed to bypass JWT verification.
|
List<? extends RouteOuterClass.RouteMatchOrBuilder> |
getBypassOrBuilderList()
This field lists the patterns allowed to bypass JWT verification.
|
Config.JwtAuthentication |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Config.JwtRule |
getRules(int index)
List of JWT rules to valide.
|
Config.JwtRule.Builder |
getRulesBuilder(int index)
List of JWT rules to valide.
|
List<Config.JwtRule.Builder> |
getRulesBuilderList()
List of JWT rules to valide.
|
int |
getRulesCount()
List of JWT rules to valide.
|
List<Config.JwtRule> |
getRulesList()
List of JWT rules to valide.
|
Config.JwtRuleOrBuilder |
getRulesOrBuilder(int index)
List of JWT rules to valide.
|
List<? extends Config.JwtRuleOrBuilder> |
getRulesOrBuilderList()
List of JWT rules to valide.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Config.JwtAuthentication.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Config.JwtAuthentication.Builder |
mergeFrom(Config.JwtAuthentication other) |
Config.JwtAuthentication.Builder |
mergeFrom(com.google.protobuf.Message other) |
Config.JwtAuthentication.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Config.JwtAuthentication.Builder |
removeBypass(int index)
This field lists the patterns allowed to bypass JWT verification.
|
Config.JwtAuthentication.Builder |
removeRules(int index)
List of JWT rules to valide.
|
Config.JwtAuthentication.Builder |
setAllowMissingOrFailed(boolean value)
If true, the request is allowed if JWT is missing or JWT verification fails.
|
Config.JwtAuthentication.Builder |
setBypass(int index,
RouteOuterClass.RouteMatch.Builder builderForValue)
This field lists the patterns allowed to bypass JWT verification.
|
Config.JwtAuthentication.Builder |
setBypass(int index,
RouteOuterClass.RouteMatch value)
This field lists the patterns allowed to bypass JWT verification.
|
Config.JwtAuthentication.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Config.JwtAuthentication.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Config.JwtAuthentication.Builder |
setRules(int index,
Config.JwtRule.Builder builderForValue)
List of JWT rules to valide.
|
Config.JwtAuthentication.Builder |
setRules(int index,
Config.JwtRule value)
List of JWT rules to valide.
|
Config.JwtAuthentication.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, 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.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtAuthentication.Builder>public Config.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<Config.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<Config.JwtAuthentication.Builder>public Config.JwtAuthentication getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Config.JwtAuthentication build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Config.JwtAuthentication buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Config.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<Config.JwtAuthentication.Builder>public Config.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<Config.JwtAuthentication.Builder>public Config.JwtAuthentication.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtAuthentication.Builder>public Config.JwtAuthentication.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtAuthentication.Builder>public Config.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<Config.JwtAuthentication.Builder>public Config.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<Config.JwtAuthentication.Builder>public Config.JwtAuthentication.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Config.JwtAuthentication.Builder>public Config.JwtAuthentication.Builder mergeFrom(Config.JwtAuthentication other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtAuthentication.Builder>public Config.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<Config.JwtAuthentication.Builder>IOExceptionpublic List<Config.JwtRule> getRulesList()
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;getRulesList in interface Config.JwtAuthenticationOrBuilderpublic int getRulesCount()
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;getRulesCount in interface Config.JwtAuthenticationOrBuilderpublic Config.JwtRule getRules(int index)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;getRules in interface Config.JwtAuthenticationOrBuilderpublic Config.JwtAuthentication.Builder setRules(int index, Config.JwtRule value)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public Config.JwtAuthentication.Builder setRules(int index, Config.JwtRule.Builder builderForValue)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public Config.JwtAuthentication.Builder addRules(Config.JwtRule value)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public Config.JwtAuthentication.Builder addRules(int index, Config.JwtRule value)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public Config.JwtAuthentication.Builder addRules(Config.JwtRule.Builder builderForValue)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public Config.JwtAuthentication.Builder addRules(int index, Config.JwtRule.Builder builderForValue)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public Config.JwtAuthentication.Builder addAllRules(Iterable<? extends Config.JwtRule> values)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public Config.JwtAuthentication.Builder clearRules()
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public Config.JwtAuthentication.Builder removeRules(int index)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public Config.JwtRule.Builder getRulesBuilder(int index)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public Config.JwtRuleOrBuilder getRulesOrBuilder(int index)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;getRulesOrBuilder in interface Config.JwtAuthenticationOrBuilderpublic List<? extends Config.JwtRuleOrBuilder> getRulesOrBuilderList()
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;getRulesOrBuilderList in interface Config.JwtAuthenticationOrBuilderpublic Config.JwtRule.Builder addRulesBuilder()
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public Config.JwtRule.Builder addRulesBuilder(int index)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public List<Config.JwtRule.Builder> getRulesBuilderList()
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;public boolean getAllowMissingOrFailed()
If true, the request is allowed if JWT is missing or JWT verification fails. Default is false, a request without JWT or failed JWT verification is not allowed.
bool allow_missing_or_failed = 2;getAllowMissingOrFailed in interface Config.JwtAuthenticationOrBuilderpublic Config.JwtAuthentication.Builder setAllowMissingOrFailed(boolean value)
If true, the request is allowed if JWT is missing or JWT verification fails. Default is false, a request without JWT or failed JWT verification is not allowed.
bool allow_missing_or_failed = 2;public Config.JwtAuthentication.Builder clearAllowMissingOrFailed()
If true, the request is allowed if JWT is missing or JWT verification fails. Default is false, a request without JWT or failed JWT verification is not allowed.
bool allow_missing_or_failed = 2;public List<RouteOuterClass.RouteMatch> getBypassList()
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;getBypassList in interface Config.JwtAuthenticationOrBuilderpublic int getBypassCount()
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;getBypassCount in interface Config.JwtAuthenticationOrBuilderpublic RouteOuterClass.RouteMatch getBypass(int index)
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;getBypass in interface Config.JwtAuthenticationOrBuilderpublic Config.JwtAuthentication.Builder setBypass(int index, RouteOuterClass.RouteMatch value)
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public Config.JwtAuthentication.Builder setBypass(int index, RouteOuterClass.RouteMatch.Builder builderForValue)
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public Config.JwtAuthentication.Builder addBypass(RouteOuterClass.RouteMatch value)
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public Config.JwtAuthentication.Builder addBypass(int index, RouteOuterClass.RouteMatch value)
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public Config.JwtAuthentication.Builder addBypass(RouteOuterClass.RouteMatch.Builder builderForValue)
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public Config.JwtAuthentication.Builder addBypass(int index, RouteOuterClass.RouteMatch.Builder builderForValue)
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public Config.JwtAuthentication.Builder addAllBypass(Iterable<? extends RouteOuterClass.RouteMatch> values)
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public Config.JwtAuthentication.Builder clearBypass()
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public Config.JwtAuthentication.Builder removeBypass(int index)
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public RouteOuterClass.RouteMatch.Builder getBypassBuilder(int index)
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public RouteOuterClass.RouteMatchOrBuilder getBypassOrBuilder(int index)
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;getBypassOrBuilder in interface Config.JwtAuthenticationOrBuilderpublic List<? extends RouteOuterClass.RouteMatchOrBuilder> getBypassOrBuilderList()
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;getBypassOrBuilderList in interface Config.JwtAuthenticationOrBuilderpublic RouteOuterClass.RouteMatch.Builder addBypassBuilder()
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public RouteOuterClass.RouteMatch.Builder addBypassBuilder(int index)
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public List<RouteOuterClass.RouteMatch.Builder> getBypassBuilderList()
This field lists the patterns allowed to bypass JWT verification. This only applies when
`allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
for CORS and some health checking paths.
Examples: bypass all CORS options requests
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: OPTIONS
- headers:
- name: :path
regex_match: /.*
Examples: bypass /healthz check
.. code-block:: yaml
bypass:
- headers:
- name: :method
value: GET
- headers:
- name: :path
exact_match: /healthz
repeated .envoy.api.v2.route.RouteMatch bypass = 3;public final Config.JwtAuthentication.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtAuthentication.Builder>public final Config.JwtAuthentication.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Config.JwtAuthentication.Builder>Copyright © 2018 The Envoy Project. All rights reserved.