googleauth - Module Google::Auth (v1.12.2)

Reference documentation and code samples for the googleauth module Google::Auth.

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

Methods

.get_application_default

def self.get_application_default(scope = nil, options = {})

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 https://cloud.google.com/docs/authentication/production.

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.

Parameters
  • scope (string|array|nil) — the scope(s) to access
  • 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.
Raises
  • (NOT_FOUND_ERROR)

Constants

VERSION

value: "1.12.2".freeze

NO_METADATA_SERVER_ERROR

value: <<~ERROR.freeze Error code 404 trying to get security access token from Compute Engine metadata for the default service account. This may be because the virtual machine instance does not have permission scopes specified. ERROR

UNEXPECTED_ERROR_SUFFIX

value: <<~ERROR.freeze trying to get security access token from Compute Engine metadata for the default service account ERROR

NOT_FOUND_ERROR

value: <<~ERROR_MESSAGE.freeze Your credentials were not found. To set up Application Default Credentials for your environment, see https://cloud.google.com/docs/authentication/external/set-up-adc ERROR_MESSAGE