IAM Service Account Credentials API - Module Google::Iam::Credentials (v1.5.0)

Reference documentation and code samples for the IAM Service Account Credentials API module Google::Iam::Credentials.

Methods

.iam_credentials

def self.iam_credentials(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for IAMCredentials.

By default, this returns an instance of Google::Iam::Credentials::V1::IAMCredentials::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the IAMCredentials service. You can determine whether the method will succeed by calling Credentials.iam_credentials_available?.

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.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.iam_credentials_available?

def self.iam_credentials_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the IAMCredentials service is supported by the current client. If true, you can retrieve a client object by calling Credentials.iam_credentials. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the IAMCredentials service, or if the versioned client gem needs an update to support the IAMCredentials service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "1.5.0"