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

Interface OAuth2.ClientCredentialsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
OAuth2.ClientCredentials, OAuth2.ClientCredentials.Builder
Enclosing class:
OAuth2
public static interface OAuth2.ClientCredentialsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    OAuth2.AuthType
    getAuthType()
    The method to use when sending credentials to the authorization server.
    int
    getAuthTypeValue()
    The method to use when sending credentials to the authorization server.
    String
    getClientId()
    Client ID.
    com.google.protobuf.ByteString
    getClientIdBytes()
    Client ID.
    SdsSecretConfig
    getClientSecret()
    Client secret.
    SdsSecretConfigOrBuilder
    getClientSecretOrBuilder()
    Client secret.
    boolean
    hasClientSecret()
    Client secret.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getClientId

      String getClientId()
       Client ID.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      string client_id = 1 [(.validate.rules) = { ... }
      Returns:
      The clientId.

    • getClientIdBytes

      com.google.protobuf.ByteString getClientIdBytes()
       Client ID.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      string client_id = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for clientId.

    • hasClientSecret

      boolean hasClientSecret()
       Client secret.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig client_secret = 2 [(.validate.rules) = { ... }
      Returns:
      Whether the clientSecret field is set.

    • getClientSecret

      SdsSecretConfig getClientSecret()
       Client secret.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig client_secret = 2 [(.validate.rules) = { ... }
      Returns:
      The clientSecret.

    • getClientSecretOrBuilder

      SdsSecretConfigOrBuilder getClientSecretOrBuilder()
       Client secret.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.transport_sockets.tls.v3.SdsSecretConfig client_secret = 2 [(.validate.rules) = { ... }

    • getAuthTypeValue

      int getAuthTypeValue()
       The method to use when sending credentials to the authorization server.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.AuthType auth_type = 3;
      Returns:
      The enum numeric value on the wire for authType.

    • getAuthType

      OAuth2.AuthType getAuthType()
       The method to use when sending credentials to the authorization server.
 Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
      .envoy.extensions.http.injected_credentials.oauth2.v3.OAuth2.AuthType auth_type = 3;
      Returns:
      The authType.