OAuth2ConfigOrBuilder (api 0.1.28 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

OAuth2Config, OAuth2Config.Builder
```
public interface OAuth2ConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getAuthorizationEndpoint()` The endpoint redirect to for authorization in response to unauthorized requests.
`com.google.protobuf.ByteString`	`getAuthorizationEndpointBytes()` The endpoint redirect to for authorization in response to unauthorized requests.
`OAuth2Credentials`	`getCredentials()` Credentials used for OAuth.
`OAuth2CredentialsOrBuilder`	`getCredentialsOrBuilder()` Credentials used for OAuth.
`boolean`	`getForwardBearerToken()` Forward the OAuth token as a Bearer to upstream web service.
`HeaderMatcher`	`getPassThroughMatcher(int index)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`int`	`getPassThroughMatcherCount()` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`List<HeaderMatcher>`	`getPassThroughMatcherList()` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`HeaderMatcherOrBuilder`	`getPassThroughMatcherOrBuilder(int index)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`List<? extends HeaderMatcherOrBuilder>`	`getPassThroughMatcherOrBuilderList()` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`PathMatcher`	`getRedirectPathMatcher()` Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
`PathMatcherOrBuilder`	`getRedirectPathMatcherOrBuilder()` Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
`String`	`getRedirectUri()` The redirect URI passed to the authorization endpoint.
`com.google.protobuf.ByteString`	`getRedirectUriBytes()` The redirect URI passed to the authorization endpoint.
`PathMatcher`	`getSignoutPath()` The path to sign a user out, clearing their credential cookies.
`PathMatcherOrBuilder`	`getSignoutPathOrBuilder()` The path to sign a user out, clearing their credential cookies.
`HttpUri`	`getTokenEndpoint()` Endpoint on the authorization server to retrieve the access token from.
`HttpUriOrBuilder`	`getTokenEndpointOrBuilder()` Endpoint on the authorization server to retrieve the access token from.
`boolean`	`hasCredentials()` Credentials used for OAuth.
`boolean`	`hasRedirectPathMatcher()` Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
`boolean`	`hasSignoutPath()` The path to sign a user out, clearing their credential cookies.
`boolean`	`hasTokenEndpoint()` Endpoint on the authorization server to retrieve the access token from.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

hasTokenEndpoint

boolean hasTokenEndpoint()

 Endpoint on the authorization server to retrieve the access token from.

.envoy.config.core.v3.HttpUri token_endpoint = 1;

getTokenEndpoint

HttpUri getTokenEndpoint()

 Endpoint on the authorization server to retrieve the access token from.

.envoy.config.core.v3.HttpUri token_endpoint = 1;

getTokenEndpointOrBuilder

HttpUriOrBuilder getTokenEndpointOrBuilder()

 Endpoint on the authorization server to retrieve the access token from.

.envoy.config.core.v3.HttpUri token_endpoint = 1;

getAuthorizationEndpoint

String getAuthorizationEndpoint()

 The endpoint redirect to for authorization in response to unauthorized requests.

string authorization_endpoint = 2 [(.validate.rules) = { ... }

getAuthorizationEndpointBytes

com.google.protobuf.ByteString getAuthorizationEndpointBytes()

 The endpoint redirect to for authorization in response to unauthorized requests.

string authorization_endpoint = 2 [(.validate.rules) = { ... }

hasCredentials
```
boolean hasCredentials()
```
```
 Credentials used for OAuth.
 
```
.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }

getCredentials
```
OAuth2Credentials getCredentials()
```
```
 Credentials used for OAuth.
 
```
.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }

getCredentialsOrBuilder
```
OAuth2CredentialsOrBuilder getCredentialsOrBuilder()
```
```
 Credentials used for OAuth.
 
```
.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }

getRedirectUri

String getRedirectUri()

 The redirect URI passed to the authorization endpoint. Supports header formatting
 tokens. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 This URI should not contain any query parameters.

string redirect_uri = 4 [(.validate.rules) = { ... }

getRedirectUriBytes

com.google.protobuf.ByteString getRedirectUriBytes()

 The redirect URI passed to the authorization endpoint. Supports header formatting
 tokens. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 This URI should not contain any query parameters.

string redirect_uri = 4 [(.validate.rules) = { ... }

hasRedirectPathMatcher

boolean hasRedirectPathMatcher()

 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.

.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }

getRedirectPathMatcher

PathMatcher getRedirectPathMatcher()

 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.

.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }

getRedirectPathMatcherOrBuilder

PathMatcherOrBuilder getRedirectPathMatcherOrBuilder()

 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.

.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }

hasSignoutPath

boolean hasSignoutPath()

 The path to sign a user out, clearing their credential cookies.

.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }

getSignoutPath

PathMatcher getSignoutPath()

 The path to sign a user out, clearing their credential cookies.

.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }

getSignoutPathOrBuilder

PathMatcherOrBuilder getSignoutPathOrBuilder()

 The path to sign a user out, clearing their credential cookies.

.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }

getForwardBearerToken

boolean getForwardBearerToken()

 Forward the OAuth token as a Bearer to upstream web service.

bool forward_bearer_token = 7;