Module: Google::Iam::Credentials

Defined in:
lib/google/iam/credentials.rb,
lib/google/iam/credentials/version.rb

Constant Summary collapse

VERSION = 
"0.1.0"

Class Method Summary collapse

Class Method Details

.iam_credentials(version: :v1, &block) ⇒ IAMCredentials::Client

Create a new client object for IAMCredentials.

By default, this returns an instance of Google::Iam::Credentials::V1::IAMCredentials::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the IAMCredentials service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About IAMCredentials

A service account is a special type of Google account that belongs to your application or a virtual machine (VM), instead of to an individual end user. Your application assumes the identity of the service account to call Google APIs, so that the users aren't directly involved.

Service account credentials are used to temporarily assume the identity of the service account. Supported credential types include OAuth 2.0 access tokens, OpenID Connect ID tokens, self-signed JSON Web Tokens (JWTs), and more.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (IAMCredentials::Client) —

    A client object for the specified version.



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/google/iam/credentials.rb', line 57

def self.iam_credentials version: :v1, &block
  require "google/iam/credentials/#{version.to_s.downcase}"

  package_name = Google::Iam::Credentials
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Iam::Credentials.const_get package_name
  package_module.const_get(:IAMCredentials).const_get(:Client).new(&block)
end