Module Google::Auth
In: lib/googleauth/version.rb
lib/googleauth/token_store.rb
lib/googleauth/stores/file_token_store.rb
lib/googleauth/stores/redis_token_store.rb
lib/googleauth/credentials_loader.rb
lib/googleauth/service_account.rb
lib/googleauth/web_user_authorizer.rb
lib/googleauth/compute_engine.rb
lib/googleauth/default_credentials.rb
lib/googleauth/credentials.rb
lib/googleauth/application_default.rb
lib/googleauth/scope_util.rb
lib/googleauth/iam.rb
lib/googleauth/client_id.rb
lib/googleauth/user_refresh.rb
lib/googleauth/json_key_reader.rb
lib/googleauth/user_authorizer.rb

Module Auth provides classes that provide Google-specific authorization used to access Google APIs.

Methods

Classes and Modules

Module Google::Auth::CredentialsLoader
Module Google::Auth::JsonKeyReader
Module Google::Auth::ScopeUtil
Module Google::Auth::Stores
Class Google::Auth::ClientId
Class Google::Auth::Credentials
Class Google::Auth::DefaultCredentials
Class Google::Auth::GCECredentials
Class Google::Auth::IAMCredentials
Class Google::Auth::ServiceAccountCredentials
Class Google::Auth::ServiceAccountJwtHeaderCredentials
Class Google::Auth::TokenStore
Class Google::Auth::UserAuthorizer
Class Google::Auth::UserRefreshCredentials
Class Google::Auth::WebUserAuthorizer

Constants

VERSION = "0.8.1".freeze
NO_METADATA_SERVER_ERROR = <<~ERROR.freeze
UNEXPECTED_ERROR_SUFFIX = <<~ERROR.freeze
NOT_FOUND_ERROR = <<~ERROR_MESSAGE.freeze

Public Instance methods

Obtains the default credentials implementation to use in this environment.

Use this to obtain the Application Default Credentials for accessing Google APIs. Application Default Credentials are described in detail at goo.gl/IUuyuX.

If supplied, scope is used to create the credentials instance, when it can be applied. E.g, on google compute engine and for user credentials the scope is ignored.

@param scope [string|array|nil] the scope(s) to access @param options [Hash] Connection options. These may be used to configure

    the `Faraday::Connection` used for outgoing HTTP requests. For
    example, if a connection proxy must be used in the current network,
    you may provide a connection with with the needed proxy options.
    The following keys are recognized:
    * `:default_connection` The connection object to use for token
      refresh requests.
    * `:connection_builder` A `Proc` that creates and returns a
      connection to use for token refresh requests.
    * `:connection` The connection to use to determine whether GCE
      metadata credentials are available.

[Validate]