Class: Google::Apis::IamcredentialsV1::IAMCredentialsService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/iamcredentials_v1/service.rb

Overview

IAM Service Account Credentials API

Creates short-lived, limited-privilege credentials for IAM service accounts.

Examples:

require 'google/apis/iamcredentials_v1'

Iamcredentials = Google::Apis::IamcredentialsV1 # Alias the module
service = Iamcredentials::IAMCredentialsService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeIAMCredentialsService


45
46
47
48
# File 'generated/google/apis/iamcredentials_v1/service.rb', line 45

def initialize
  super('https://iamcredentials.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/iamcredentials_v1/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/iamcredentials_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#generate_service_account_access_token(name, generate_access_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IamcredentialsV1::GenerateAccessTokenResponse

Generates an OAuth 2.0 access token for a service account.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


73
74
75
76
77
78
79
80
81
82
83
# File 'generated/google/apis/iamcredentials_v1/service.rb', line 73

def (name, generate_access_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:generateAccessToken', options)
  command.request_representation = Google::Apis::IamcredentialsV1::GenerateAccessTokenRequest::Representation
  command.request_object = generate_access_token_request_object
  command.response_representation = Google::Apis::IamcredentialsV1::GenerateAccessTokenResponse::Representation
  command.response_class = Google::Apis::IamcredentialsV1::GenerateAccessTokenResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_service_account_id_token(name, generate_id_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IamcredentialsV1::GenerateIdTokenResponse

Generates an OpenID Connect ID token for a service account.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


108
109
110
111
112
113
114
115
116
117
118
# File 'generated/google/apis/iamcredentials_v1/service.rb', line 108

def (name, generate_id_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:generateIdToken', options)
  command.request_representation = Google::Apis::IamcredentialsV1::GenerateIdTokenRequest::Representation
  command.request_object = generate_id_token_request_object
  command.response_representation = Google::Apis::IamcredentialsV1::GenerateIdTokenResponse::Representation
  command.response_class = Google::Apis::IamcredentialsV1::GenerateIdTokenResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_service_account_identity_binding_access_token(name, generate_identity_binding_access_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IamcredentialsV1::GenerateIdentityBindingAccessTokenResponse

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


143
144
145
146
147
148
149
150
151
152
153
# File 'generated/google/apis/iamcredentials_v1/service.rb', line 143

def (name, generate_identity_binding_access_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:generateIdentityBindingAccessToken', options)
  command.request_representation = Google::Apis::IamcredentialsV1::GenerateIdentityBindingAccessTokenRequest::Representation
  command.request_object = generate_identity_binding_access_token_request_object
  command.response_representation = Google::Apis::IamcredentialsV1::GenerateIdentityBindingAccessTokenResponse::Representation
  command.response_class = Google::Apis::IamcredentialsV1::GenerateIdentityBindingAccessTokenResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#sign_service_account_blob(name, sign_blob_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IamcredentialsV1::SignBlobResponse

Signs a blob using a service account's system-managed private key.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


178
179
180
181
182
183
184
185
186
187
188
# File 'generated/google/apis/iamcredentials_v1/service.rb', line 178

def (name, sign_blob_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:signBlob', options)
  command.request_representation = Google::Apis::IamcredentialsV1::SignBlobRequest::Representation
  command.request_object = sign_blob_request_object
  command.response_representation = Google::Apis::IamcredentialsV1::SignBlobResponse::Representation
  command.response_class = Google::Apis::IamcredentialsV1::SignBlobResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#sign_service_account_jwt(name, sign_jwt_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IamcredentialsV1::SignJwtResponse

Signs a JWT using a service account's system-managed private key.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


213
214
215
216
217
218
219
220
221
222
223
# File 'generated/google/apis/iamcredentials_v1/service.rb', line 213

def (name, sign_jwt_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:signJwt', options)
  command.request_representation = Google::Apis::IamcredentialsV1::SignJwtRequest::Representation
  command.request_object = sign_jwt_request_object
  command.response_representation = Google::Apis::IamcredentialsV1::SignJwtResponse::Representation
  command.response_class = Google::Apis::IamcredentialsV1::SignJwtResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end