Package io.envoyproxy.envoy.extensions.http.injected_credentials.oauth2.v3

Interface OAuth2OrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
OAuth2, OAuth2.Builder
public interface OAuth2OrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasTokenEndpoint

      boolean hasTokenEndpoint()
       Endpoint on the authorization server to retrieve the access token from.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-3.2) for details.
      .envoy.config.core.v3.HttpUri token_endpoint = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the tokenEndpoint field is set.

    • getTokenEndpoint

      HttpUri getTokenEndpoint()
       Endpoint on the authorization server to retrieve the access token from.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-3.2) for details.
      .envoy.config.core.v3.HttpUri token_endpoint = 1 [(.validate.rules) = { ... }
      Returns:
      The tokenEndpoint.

    • getTokenEndpointOrBuilder

      HttpUriOrBuilder getTokenEndpointOrBuilder()
       Endpoint on the authorization server to retrieve the access token from.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-3.2) for details.
      .envoy.config.core.v3.HttpUri token_endpoint = 1 [(.validate.rules) = { ... }

    • getScopesList

      List<String> getScopesList()
       Optional list of OAuth scopes to be claimed in the authorization request.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4.2) for details.
      repeated string scopes = 2;
      Returns:
      A list containing the scopes.

    • getScopesCount

      int getScopesCount()
       Optional list of OAuth scopes to be claimed in the authorization request.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4.2) for details.
      repeated string scopes = 2;
      Returns:
      The count of scopes.

    • getScopes

      String getScopes(int index)
       Optional list of OAuth scopes to be claimed in the authorization request.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4.2) for details.
      repeated string scopes = 2;
      Parameters:
      index - The index of the element to return.
      Returns:
      The scopes at the given index.

    • getScopesBytes

      com.google.protobuf.ByteString getScopesBytes(int index)
       Optional list of OAuth scopes to be claimed in the authorization request.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4.2) for details.
      repeated string scopes = 2;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the scopes at the given index.

    • hasClientCredentials

      boolean hasClientCredentials()
       Client Credentials Grant.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4) for details.
      .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.ClientCredentials client_credentials = 3;
      Returns:
      Whether the clientCredentials field is set.

    • getClientCredentials

      OAuth2.ClientCredentials getClientCredentials()
       Client Credentials Grant.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4) for details.
      .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.ClientCredentials client_credentials = 3;
      Returns:
      The clientCredentials.

    • getClientCredentialsOrBuilder

      OAuth2.ClientCredentialsOrBuilder getClientCredentialsOrBuilder()
       Client Credentials Grant.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4) for details.
      .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.ClientCredentials client_credentials = 3;

    • hasTokenFetchRetryInterval

      boolean hasTokenFetchRetryInterval()
       The interval between two successive retries to fetch token from Identity Provider. Default is 2 secs.
 The interval must be at least 1 second.
      .google.protobuf.Duration token_fetch_retry_interval = 4 [(.validate.rules) = { ... }
      Returns:
      Whether the tokenFetchRetryInterval field is set.

    • getTokenFetchRetryInterval

      com.google.protobuf.Duration getTokenFetchRetryInterval()
       The interval between two successive retries to fetch token from Identity Provider. Default is 2 secs.
 The interval must be at least 1 second.
      .google.protobuf.Duration token_fetch_retry_interval = 4 [(.validate.rules) = { ... }
      Returns:
      The tokenFetchRetryInterval.

    • getTokenFetchRetryIntervalOrBuilder

      com.google.protobuf.DurationOrBuilder getTokenFetchRetryIntervalOrBuilder()
       The interval between two successive retries to fetch token from Identity Provider. Default is 2 secs.
 The interval must be at least 1 second.
      .google.protobuf.Duration token_fetch_retry_interval = 4 [(.validate.rules) = { ... }

    • getEndpointParamsList

      List<OAuth2.EndpointParameter> getEndpointParamsList()
       Optional list of additional parameters to send to the token endpoint.
 These parameters will be URL-encoded and included in the token request body.
      repeated .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.EndpointParameter endpoint_params = 5;

    • getEndpointParams

      OAuth2.EndpointParameter getEndpointParams(int index)
       Optional list of additional parameters to send to the token endpoint.
 These parameters will be URL-encoded and included in the token request body.
      repeated .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.EndpointParameter endpoint_params = 5;

    • getEndpointParamsCount

      int getEndpointParamsCount()
       Optional list of additional parameters to send to the token endpoint.
 These parameters will be URL-encoded and included in the token request body.
      repeated .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.EndpointParameter endpoint_params = 5;

    • getEndpointParamsOrBuilderList

      List<? extends OAuth2.EndpointParameterOrBuilder> getEndpointParamsOrBuilderList()
       Optional list of additional parameters to send to the token endpoint.
 These parameters will be URL-encoded and included in the token request body.
      repeated .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.EndpointParameter endpoint_params = 5;

    • getEndpointParamsOrBuilder

      OAuth2.EndpointParameterOrBuilder getEndpointParamsOrBuilder(int index)
       Optional list of additional parameters to send to the token endpoint.
 These parameters will be URL-encoded and included in the token request body.
      repeated .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.EndpointParameter endpoint_params = 5;

    • getFlowTypeCase

      OAuth2.FlowTypeCase getFlowTypeCase()