googleauth - Class Google::Auth::DefaultCredentials (v1.15.1)

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

DefaultCredentials is used to preload the credentials file, to determine which type of credentials should be loaded.

Inherits

  • Object

Extended By

Methods

.determine_creds_class

def self.determine_creds_class(json_key_io = nil) -> Array(Hash, Class)

Reads the input json and determines which creds class to use.

Parameter
  • json_key_io (IO, nil) — An optional IO object containing the JSON key. If nil, the credential type is determined from environment variables.
Returns
  • (Array(Hash, Class)) — The JSON key (or nil if from environment) and the credential class to use
Raises
  • (Google::Auth::InitializationError) — If the JSON is missing the type field or has an unsupported type, or if the environment variable is undefined or unsupported.

.make_creds

def self.make_creds(options = {}) -> Google::Auth::Credentials

Override CredentialsLoader#make_creds to use the class determined by loading the json.

Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information, refer to Validate credential configurations from external sources.

Parameter
  • options (Hash) — Options for creating the credentials
Returns
Raises