Uses of Class
io.envoyproxy.envoy.extensions.filters.http.oauth2.v3.OAuth2Config.Builder
Packages that use OAuth2Config.Builder
-
Uses of OAuth2Config.Builder in io.envoyproxy.envoy.extensions.filters.http.oauth2.v3
Methods in io.envoyproxy.envoy.extensions.filters.http.oauth2.v3 that return OAuth2Config.BuilderModifier and TypeMethodDescriptionOAuth2Config.Builder.addAllAuthScopes(Iterable<String> values) Optional list of OAuth scopes to be claimed in the authorization request.OAuth2Config.Builder.addAllDenyRedirectMatcher(Iterable<? extends HeaderMatcher> values) Any request that matches any of the provided matchers won't be redirected to OAuth server when tokens are not valid.OAuth2Config.Builder.addAllPassThroughMatcher(Iterable<? extends HeaderMatcher> values) Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.Builder.addAllResources(Iterable<String> values) Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707OAuth2Config.Builder.addAuthScopes(String value) Optional list of OAuth scopes to be claimed in the authorization request.OAuth2Config.Builder.addAuthScopesBytes(com.google.protobuf.ByteString value) Optional list of OAuth scopes to be claimed in the authorization request.OAuth2Config.Builder.addDenyRedirectMatcher(int index, HeaderMatcher value) Any request that matches any of the provided matchers won't be redirected to OAuth server when tokens are not valid.OAuth2Config.Builder.addDenyRedirectMatcher(int index, HeaderMatcher.Builder builderForValue) Any request that matches any of the provided matchers won't be redirected to OAuth server when tokens are not valid.OAuth2Config.Builder.addDenyRedirectMatcher(HeaderMatcher value) Any request that matches any of the provided matchers won't be redirected to OAuth server when tokens are not valid.OAuth2Config.Builder.addDenyRedirectMatcher(HeaderMatcher.Builder builderForValue) Any request that matches any of the provided matchers won't be redirected to OAuth server when tokens are not valid.OAuth2Config.Builder.addPassThroughMatcher(int index, HeaderMatcher value) Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.Builder.addPassThroughMatcher(int index, HeaderMatcher.Builder builderForValue) Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.Builder.addPassThroughMatcher(HeaderMatcher value) Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.Builder.addPassThroughMatcher(HeaderMatcher.Builder builderForValue) Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.Builder.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) OAuth2Config.Builder.addResources(String value) Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707OAuth2Config.Builder.addResourcesBytes(com.google.protobuf.ByteString value) Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707OAuth2Config.Builder.clear()OAuth2Config.Builder.clearAuthorizationEndpoint()The endpoint redirect to for authorization in response to unauthorized requests.OAuth2Config.Builder.clearAuthScopes()Optional list of OAuth scopes to be claimed in the authorization request.OAuth2Config.Builder.clearAuthType()Defines how ``client_id`` and ``client_secret`` are sent in OAuth client to OAuth server requests.OAuth2Config.Builder.clearCodeVerifierTokenExpiresIn()Optional expiration time for the code verifier cookie.OAuth2Config.Builder.clearCookieConfigs()Controls for attributes that can be set on the cookies.OAuth2Config.Builder.clearCredentials()Credentials used for OAuth.OAuth2Config.Builder.clearCsrfTokenExpiresIn()Optional expiration time for the CSRF protection token cookie.OAuth2Config.Builder.clearDefaultExpiresIn()The default lifetime in seconds of the access token, if omitted by the authorization server.OAuth2Config.Builder.clearDefaultRefreshTokenExpiresIn()The default lifetime in seconds of the refresh token, if the exp (expiration time) claim is omitted in the refresh token or the refresh token is not JWT.OAuth2Config.Builder.clearDenyRedirectMatcher()Any request that matches any of the provided matchers won't be redirected to OAuth server when tokens are not valid.OAuth2Config.Builder.clearDisableAccessTokenSetCookie()If set to true, the client will not set a cookie for Access Token even if one is received from the Identity Provider.OAuth2Config.Builder.clearDisableIdTokenSetCookie()If set to true, the client will not set a cookie for ID Token even if one is received from the Identity Provider.OAuth2Config.Builder.clearDisableRefreshTokenSetCookie()If set to true, the client will not set a cookie for Refresh Token even if one is received from the Identity Provider.OAuth2Config.Builder.clearDisableTokenEncryption()Disable token encryption.OAuth2Config.Builder.clearEndSessionEndpoint()The endpoint at the authorization server to request the user be logged out of the Authorization server.OAuth2Config.Builder.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) OAuth2Config.Builder.clearForwardBearerToken()Forward the OAuth token as a Bearer to upstream web service.OAuth2Config.Builder.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) OAuth2Config.Builder.clearPassThroughMatcher()Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.Builder.clearPreserveAuthorizationHeader()If set to true, preserve the existing authorization header.OAuth2Config.Builder.clearRedirectPathMatcher()Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.OAuth2Config.Builder.clearRedirectUri()The redirect URI passed to the authorization endpoint.OAuth2Config.Builder.clearResources()Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707OAuth2Config.Builder.clearRetryPolicy()Specifies the retry policy for requests to the OAuth server.OAuth2Config.Builder.clearSignoutPath()The path to sign a user out, clearing their credential cookies.OAuth2Config.Builder.clearStatPrefix()Optional additional prefix to use when emitting statistics.OAuth2Config.Builder.clearTokenEndpoint()Endpoint on the authorization server to retrieve the access token from.OAuth2Config.Builder.clearUseRefreshToken()If set to true, allows automatic access token refresh using the associated refresh token (see `RFC 6749 section 6 <https://datatracker.ietf.org/doc/html/rfc6749#section-6>`_), provided that the OAuth server supports that.OAuth2Config.Builder.clone()OAuth2.Builder.getConfigBuilder()Leave this empty to disable OAuth2 for a specific route, using per filter config.OAuth2Config.Builder.mergeCodeVerifierTokenExpiresIn(com.google.protobuf.Duration value) Optional expiration time for the code verifier cookie.OAuth2Config.Builder.mergeCookieConfigs(CookieConfigs value) Controls for attributes that can be set on the cookies.OAuth2Config.Builder.mergeCredentials(OAuth2Credentials value) Credentials used for OAuth.OAuth2Config.Builder.mergeCsrfTokenExpiresIn(com.google.protobuf.Duration value) Optional expiration time for the CSRF protection token cookie.OAuth2Config.Builder.mergeDefaultExpiresIn(com.google.protobuf.Duration value) The default lifetime in seconds of the access token, if omitted by the authorization server.OAuth2Config.Builder.mergeDefaultRefreshTokenExpiresIn(com.google.protobuf.Duration value) The default lifetime in seconds of the refresh token, if the exp (expiration time) claim is omitted in the refresh token or the refresh token is not JWT.OAuth2Config.Builder.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) OAuth2Config.Builder.mergeFrom(com.google.protobuf.Message other) OAuth2Config.Builder.mergeFrom(OAuth2Config other) OAuth2Config.Builder.mergeRedirectPathMatcher(PathMatcher value) Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.OAuth2Config.Builder.mergeRetryPolicy(RetryPolicy value) Specifies the retry policy for requests to the OAuth server.OAuth2Config.Builder.mergeSignoutPath(PathMatcher value) The path to sign a user out, clearing their credential cookies.OAuth2Config.Builder.mergeTokenEndpoint(HttpUri value) Endpoint on the authorization server to retrieve the access token from.final OAuth2Config.BuilderOAuth2Config.Builder.mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) OAuth2Config.Builder.mergeUseRefreshToken(com.google.protobuf.BoolValue value) If set to true, allows automatic access token refresh using the associated refresh token (see `RFC 6749 section 6 <https://datatracker.ietf.org/doc/html/rfc6749#section-6>`_), provided that the OAuth server supports that.static OAuth2Config.BuilderOAuth2Config.newBuilder()static OAuth2Config.BuilderOAuth2Config.newBuilder(OAuth2Config prototype) OAuth2Config.newBuilderForType()protected OAuth2Config.BuilderOAuth2Config.newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) OAuth2Config.Builder.removeDenyRedirectMatcher(int index) Any request that matches any of the provided matchers won't be redirected to OAuth server when tokens are not valid.OAuth2Config.Builder.removePassThroughMatcher(int index) Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.Builder.setAuthorizationEndpoint(String value) The endpoint redirect to for authorization in response to unauthorized requests.OAuth2Config.Builder.setAuthorizationEndpointBytes(com.google.protobuf.ByteString value) The endpoint redirect to for authorization in response to unauthorized requests.OAuth2Config.Builder.setAuthScopes(int index, String value) Optional list of OAuth scopes to be claimed in the authorization request.OAuth2Config.Builder.setAuthType(OAuth2Config.AuthType value) Defines how ``client_id`` and ``client_secret`` are sent in OAuth client to OAuth server requests.OAuth2Config.Builder.setAuthTypeValue(int value) Defines how ``client_id`` and ``client_secret`` are sent in OAuth client to OAuth server requests.OAuth2Config.Builder.setCodeVerifierTokenExpiresIn(com.google.protobuf.Duration value) Optional expiration time for the code verifier cookie.OAuth2Config.Builder.setCodeVerifierTokenExpiresIn(com.google.protobuf.Duration.Builder builderForValue) Optional expiration time for the code verifier cookie.OAuth2Config.Builder.setCookieConfigs(CookieConfigs value) Controls for attributes that can be set on the cookies.OAuth2Config.Builder.setCookieConfigs(CookieConfigs.Builder builderForValue) Controls for attributes that can be set on the cookies.OAuth2Config.Builder.setCredentials(OAuth2Credentials value) Credentials used for OAuth.OAuth2Config.Builder.setCredentials(OAuth2Credentials.Builder builderForValue) Credentials used for OAuth.OAuth2Config.Builder.setCsrfTokenExpiresIn(com.google.protobuf.Duration value) Optional expiration time for the CSRF protection token cookie.OAuth2Config.Builder.setCsrfTokenExpiresIn(com.google.protobuf.Duration.Builder builderForValue) Optional expiration time for the CSRF protection token cookie.OAuth2Config.Builder.setDefaultExpiresIn(com.google.protobuf.Duration value) The default lifetime in seconds of the access token, if omitted by the authorization server.OAuth2Config.Builder.setDefaultExpiresIn(com.google.protobuf.Duration.Builder builderForValue) The default lifetime in seconds of the access token, if omitted by the authorization server.OAuth2Config.Builder.setDefaultRefreshTokenExpiresIn(com.google.protobuf.Duration value) The default lifetime in seconds of the refresh token, if the exp (expiration time) claim is omitted in the refresh token or the refresh token is not JWT.OAuth2Config.Builder.setDefaultRefreshTokenExpiresIn(com.google.protobuf.Duration.Builder builderForValue) The default lifetime in seconds of the refresh token, if the exp (expiration time) claim is omitted in the refresh token or the refresh token is not JWT.OAuth2Config.Builder.setDenyRedirectMatcher(int index, HeaderMatcher value) Any request that matches any of the provided matchers won't be redirected to OAuth server when tokens are not valid.OAuth2Config.Builder.setDenyRedirectMatcher(int index, HeaderMatcher.Builder builderForValue) Any request that matches any of the provided matchers won't be redirected to OAuth server when tokens are not valid.OAuth2Config.Builder.setDisableAccessTokenSetCookie(boolean value) If set to true, the client will not set a cookie for Access Token even if one is received from the Identity Provider.OAuth2Config.Builder.setDisableIdTokenSetCookie(boolean value) If set to true, the client will not set a cookie for ID Token even if one is received from the Identity Provider.OAuth2Config.Builder.setDisableRefreshTokenSetCookie(boolean value) If set to true, the client will not set a cookie for Refresh Token even if one is received from the Identity Provider.OAuth2Config.Builder.setDisableTokenEncryption(boolean value) Disable token encryption.OAuth2Config.Builder.setEndSessionEndpoint(String value) The endpoint at the authorization server to request the user be logged out of the Authorization server.OAuth2Config.Builder.setEndSessionEndpointBytes(com.google.protobuf.ByteString value) The endpoint at the authorization server to request the user be logged out of the Authorization server.OAuth2Config.Builder.setForwardBearerToken(boolean value) Forward the OAuth token as a Bearer to upstream web service.OAuth2Config.Builder.setPassThroughMatcher(int index, HeaderMatcher value) Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.Builder.setPassThroughMatcher(int index, HeaderMatcher.Builder builderForValue) Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.Builder.setPreserveAuthorizationHeader(boolean value) If set to true, preserve the existing authorization header.OAuth2Config.Builder.setRedirectPathMatcher(PathMatcher value) Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.OAuth2Config.Builder.setRedirectPathMatcher(PathMatcher.Builder builderForValue) Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.OAuth2Config.Builder.setRedirectUri(String value) The redirect URI passed to the authorization endpoint.OAuth2Config.Builder.setRedirectUriBytes(com.google.protobuf.ByteString value) The redirect URI passed to the authorization endpoint.OAuth2Config.Builder.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) OAuth2Config.Builder.setResources(int index, String value) Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707OAuth2Config.Builder.setRetryPolicy(RetryPolicy value) Specifies the retry policy for requests to the OAuth server.OAuth2Config.Builder.setRetryPolicy(RetryPolicy.Builder builderForValue) Specifies the retry policy for requests to the OAuth server.OAuth2Config.Builder.setSignoutPath(PathMatcher value) The path to sign a user out, clearing their credential cookies.OAuth2Config.Builder.setSignoutPath(PathMatcher.Builder builderForValue) The path to sign a user out, clearing their credential cookies.OAuth2Config.Builder.setStatPrefix(String value) Optional additional prefix to use when emitting statistics.OAuth2Config.Builder.setStatPrefixBytes(com.google.protobuf.ByteString value) Optional additional prefix to use when emitting statistics.OAuth2Config.Builder.setTokenEndpoint(HttpUri value) Endpoint on the authorization server to retrieve the access token from.OAuth2Config.Builder.setTokenEndpoint(HttpUri.Builder builderForValue) Endpoint on the authorization server to retrieve the access token from.final OAuth2Config.BuilderOAuth2Config.Builder.setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) OAuth2Config.Builder.setUseRefreshToken(com.google.protobuf.BoolValue value) If set to true, allows automatic access token refresh using the associated refresh token (see `RFC 6749 section 6 <https://datatracker.ietf.org/doc/html/rfc6749#section-6>`_), provided that the OAuth server supports that.OAuth2Config.Builder.setUseRefreshToken(com.google.protobuf.BoolValue.Builder builderForValue) If set to true, allows automatic access token refresh using the associated refresh token (see `RFC 6749 section 6 <https://datatracker.ietf.org/doc/html/rfc6749#section-6>`_), provided that the OAuth server supports that.OAuth2Config.toBuilder()Methods in io.envoyproxy.envoy.extensions.filters.http.oauth2.v3 with parameters of type OAuth2Config.BuilderModifier and TypeMethodDescriptionOAuth2.Builder.setConfig(OAuth2Config.Builder builderForValue) Leave this empty to disable OAuth2 for a specific route, using per filter config.