Class: Google::Apis::ClouduseraccountsBeta::CloudUserAccountsService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/clouduseraccounts_beta/service.rb

Overview

Cloud User Accounts API

Creates and manages users and groups for accessing Google Compute Engine virtual machines.

Examples:

require 'google/apis/clouduseraccounts_beta'

Clouduseraccounts = Google::Apis::ClouduseraccountsBeta # Alias the module
service = Clouduseraccounts::CloudUserAccountsService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initializeCloudUserAccountsService


52
53
54
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 52

def initialize
  super('https://www.googleapis.com/', 'clouduseraccounts/beta/projects/')
end

Instance Attribute Details

#keyString


39
40
41
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 39

def key
  @key
end

#quota_userString


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

def quota_user
  @quota_user
end

#user_ipString


50
51
52
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 50

def user_ip
  @user_ip
end

Instance Method Details

#add_group_member(project, group_name, groups_add_member_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::Operation

Adds users to the specified group.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 237

def add_group_member(project, group_name, groups_add_member_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/groups/{groupName}/addMember', options)
  command.request_representation = Google::Apis::ClouduseraccountsBeta::GroupsAddMemberRequest::Representation
  command.request_object = groups_add_member_request_object
  command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::Operation
  command.params['project'] = project unless project.nil?
  command.params['groupName'] = group_name unless group_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#add_user_public_key(project, user, public_key_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::Operation

Adds a public key to the specified User resource with the data included in the request.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


646
647
648
649
650
651
652
653
654
655
656
657
658
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 646

def add_user_public_key(project, user, public_key_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/users/{user}/addPublicKey', options)
  command.request_representation = Google::Apis::ClouduseraccountsBeta::PublicKey::Representation
  command.request_object = public_key_object
  command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::Operation
  command.params['project'] = project unless project.nil?
  command.params['user'] = user unless user.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_global_accounts_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes the specified operation resource.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


82
83
84
85
86
87
88
89
90
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 82

def delete_global_accounts_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{project}/global/operations/{operation}', options)
  command.params['project'] = project unless project.nil?
  command.params['operation'] = operation unless operation.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_group(project, group_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::Operation

Deletes the specified Group resource.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


277
278
279
280
281
282
283
284
285
286
287
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 277

def delete_group(project, group_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{project}/global/groups/{groupName}', options)
  command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::Operation
  command.params['project'] = project unless project.nil?
  command.params['groupName'] = group_name unless group_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_user(project, user, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::Operation

Deletes the specified User resource.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


686
687
688
689
690
691
692
693
694
695
696
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 686

def delete_user(project, user, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{project}/global/users/{user}', options)
  command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::Operation
  command.params['project'] = project unless project.nil?
  command.params['user'] = user unless user.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_global_accounts_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::Operation

Retrieves the specified operation resource.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


118
119
120
121
122
123
124
125
126
127
128
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 118

def get_global_accounts_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/global/operations/{operation}', options)
  command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::Operation
  command.params['project'] = project unless project.nil?
  command.params['operation'] = operation unless operation.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_group(project, group_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::Group

Returns the specified Group resource.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


315
316
317
318
319
320
321
322
323
324
325
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 315

def get_group(project, group_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/global/groups/{groupName}', options)
  command.response_representation = Google::Apis::ClouduseraccountsBeta::Group::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::Group
  command.params['project'] = project unless project.nil?
  command.params['groupName'] = group_name unless group_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_linux_authorized_keys_view(project, zone, user, instance, login: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::LinuxGetAuthorizedKeysViewResponse

Returns a list of authorized public keys for a specific user account.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


518
519
520
521
522
523
524
525
526
527
528
529
530
531
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 518

def get_linux_authorized_keys_view(project, zone, user, instance, login: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/zones/{zone}/authorizedKeysView/{user}', options)
  command.response_representation = Google::Apis::ClouduseraccountsBeta::LinuxGetAuthorizedKeysViewResponse::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::LinuxGetAuthorizedKeysViewResponse
  command.params['project'] = project unless project.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['user'] = user unless user.nil?
  command.query['instance'] = instance unless instance.nil?
  command.query['login'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_linux_linux_account_views(project, zone, instance, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::LinuxGetLinuxAccountViewsResponse

Retrieves a list of user accounts for an instance within a specific project.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 601

def (project, zone, instance, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/zones/{zone}/linuxAccountViews', options)
  command.response_representation = Google::Apis::ClouduseraccountsBeta::LinuxGetLinuxAccountViewsResponse::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::LinuxGetLinuxAccountViewsResponse
  command.params['project'] = project unless project.nil?
  command.params['zone'] = zone unless zone.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['instance'] = instance unless instance.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_user(project, user, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::User

Returns the specified User resource.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


724
725
726
727
728
729
730
731
732
733
734
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 724

def get_user(project, user, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/global/users/{user}', options)
  command.response_representation = Google::Apis::ClouduseraccountsBeta::User::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::User
  command.params['project'] = project unless project.nil?
  command.params['user'] = user unless user.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_group(project, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::Operation

Creates a Group resource in the specified project using the data included in the request.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


353
354
355
356
357
358
359
360
361
362
363
364
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 353

def insert_group(project, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/groups', options)
  command.request_representation = Google::Apis::ClouduseraccountsBeta::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::Operation
  command.params['project'] = project unless project.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_user(project, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::Operation

Creates a User resource in the specified project using the data included in the request.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


762
763
764
765
766
767
768
769
770
771
772
773
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 762

def insert_user(project, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/users', options)
  command.request_representation = Google::Apis::ClouduseraccountsBeta::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::Operation
  command.params['project'] = project unless project.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_global_accounts_operations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::OperationList

Retrieves the list of operation resources contained within the specified project.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 195

def list_global_accounts_operations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/global/operations', options)
  command.response_representation = Google::Apis::ClouduseraccountsBeta::OperationList::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::OperationList
  command.params['project'] = project unless project.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_groups(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::GroupList

Retrieves the list of groups contained within the specified project.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


430
431
432
433
434
435
436
437
438
439
440
441
442
443
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 430

def list_groups(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/global/groups', options)
  command.response_representation = Google::Apis::ClouduseraccountsBeta::GroupList::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::GroupList
  command.params['project'] = project unless project.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_users(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::UserList

Retrieves a list of users contained within the specified project.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


839
840
841
842
843
844
845
846
847
848
849
850
851
852
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 839

def list_users(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/global/users', options)
  command.response_representation = Google::Apis::ClouduseraccountsBeta::UserList::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::UserList
  command.params['project'] = project unless project.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#remove_group_member(project, group_name, groups_remove_member_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::Operation

Removes users from the specified group.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 472

def remove_group_member(project, group_name, groups_remove_member_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/groups/{groupName}/removeMember', options)
  command.request_representation = Google::Apis::ClouduseraccountsBeta::GroupsRemoveMemberRequest::Representation
  command.request_object = groups_remove_member_request_object
  command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::Operation
  command.params['project'] = project unless project.nil?
  command.params['groupName'] = group_name unless group_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#remove_user_public_key(project, user, fingerprint, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsBeta::Operation

Removes the specified public key from the user.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


884
885
886
887
888
889
890
891
892
893
894
895
# File 'generated/google/apis/clouduseraccounts_beta/service.rb', line 884

def remove_user_public_key(project, user, fingerprint, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/users/{user}/removePublicKey', options)
  command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsBeta::Operation
  command.params['project'] = project unless project.nil?
  command.params['user'] = user unless user.nil?
  command.query['fingerprint'] = fingerprint unless fingerprint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end