Module: Google::Auth

Defined in:
lib/googleauth.rb,
lib/googleauth/iam.rb,
lib/googleauth/version.rb,
lib/googleauth/client_id.rb,
lib/googleauth/scope_util.rb,
lib/googleauth/token_store.rb,
lib/googleauth/user_refresh.rb,
lib/googleauth/compute_engine.rb,
lib/googleauth/service_account.rb,
lib/googleauth/user_authorizer.rb,
lib/googleauth/credentials_loader.rb,
lib/googleauth/web_user_authorizer.rb,
lib/googleauth/stores/file_token_store.rb,
lib/googleauth/stores/redis_token_store.rb

Overview

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

Defined Under Namespace

Modules: CredentialsLoader, ScopeUtil, Stores Classes: ClientId, DefaultCredentials, GCECredentials, IAMCredentials, ServiceAccountCredentials, ServiceAccountJwtHeaderCredentials, TokenStore, UserAuthorizer, UserRefreshCredentials, WebUserAuthorizer

Constant Summary collapse

NOT_FOUND_ERROR = 
"Could not load the default credentials. Browse to\nhttps://developers.google.com/accounts/docs/application-default-credentials\nfor more information\n"
VERSION = 
'0.5.0'
NO_METADATA_SERVER_ERROR = 
"Error code 404 trying to get security access token\nfrom Compute Engine metadata for the default service account. This\nmay be because the virtual machine instance does not have permission\nscopes specified.\n"
UNEXPECTED_ERROR_SUFFIX = 
"trying to get security access token from Compute Engine metadata for\nthe default service account\n"

Class Method Summary collapse

Class Method Details

.get_application_default(scope = nil, options = {}) ⇒ Object

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.

Parameters:

  • scope (string|array|nil) (defaults to: nil) —

    the scope(s) to access

  • options (hash) (defaults to: {}) —

    allows override of the connection being used



114
115
116
117
118
119
120
121
 
# File 'lib/googleauth.rb', line 114

def get_application_default(scope = nil, options = {})
  creds = DefaultCredentials.from_env(scope) ||
          DefaultCredentials.from_well_known_path(scope) ||
          DefaultCredentials.from_system_default_path(scope)
  return creds unless creds.nil?
  fail NOT_FOUND_ERROR unless GCECredentials.on_gce?(options)
  GCECredentials.new
end