Class: Google::Apis::ClouduseraccountsAlpha::CloudUserAccountsService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/clouduseraccounts_alpha/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_alpha'

Clouduseraccounts = Google::Apis::ClouduseraccountsAlpha # 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

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initializeCloudUserAccountsService

Returns a new instance of CloudUserAccountsService



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

def initialize
  super('https://www.googleapis.com/', 'clouduseraccounts/alpha/projects/')
  @batch_path = 'batch/clouduseraccounts/alpha'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



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

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.



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

def quota_user
  @quota_user
end

#user_ipString

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



50
51
52
# File 'generated/google/apis/clouduseraccounts_alpha/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::ClouduseraccountsAlpha::Operation

Adds users to the specified group.

Parameters:

  • project (String)

    Project ID for this request.

  • group_name (String)

    Name of the group for this request.

  • groups_add_member_request_object (Google::Apis::ClouduseraccountsAlpha::GroupsAddMemberRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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::ClouduseraccountsAlpha::GroupsAddMemberRequest::Representation
  command.request_object = groups_add_member_request_object
  command.response_representation = Google::Apis::ClouduseraccountsAlpha::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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::ClouduseraccountsAlpha::Operation

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

Parameters:

  • project (String)

    Project ID for this request.

  • user (String)

    Name of the user for this request.

  • public_key_object (Google::Apis::ClouduseraccountsAlpha::PublicKey) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 769

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::ClouduseraccountsAlpha::PublicKey::Representation
  command.request_object = public_key_object
  command.response_representation = Google::Apis::ClouduseraccountsAlpha::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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.

Parameters:

  • project (String)

    Project ID for this request.

  • operation (String)

    Name of the Operations resource to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

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:



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

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::ClouduseraccountsAlpha::Operation

Deletes the specified Group resource.

Parameters:

  • project (String)

    Project ID for this request.

  • group_name (String)

    Name of the Group resource to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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::ClouduseraccountsAlpha::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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::ClouduseraccountsAlpha::Operation

Deletes the specified User resource.

Parameters:

  • project (String)

    Project ID for this request.

  • user (String)

    Name of the user resource to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



809
810
811
812
813
814
815
816
817
818
819
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 809

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::ClouduseraccountsAlpha::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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::ClouduseraccountsAlpha::Operation

Retrieves the specified operation resource.

Parameters:

  • project (String)

    Project ID for this request.

  • operation (String)

    Name of the Operations resource to return.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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::ClouduseraccountsAlpha::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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::ClouduseraccountsAlpha::Group

Returns the specified Group resource.

Parameters:

  • project (String)

    Project ID for this request.

  • group_name (String)

    Name of the Group resource to return.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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::ClouduseraccountsAlpha::Group::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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_group_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsAlpha::Policy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters:

  • project (String)

    Project ID for this request.

  • resource (String)

    Name of the resource for this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_group_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/global/groups/{resource}/getIamPolicy', options)
  command.response_representation = Google::Apis::ClouduseraccountsAlpha::Policy::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::Policy
  command.params['project'] = project unless project.nil?
  command.params['resource'] = resource unless resource.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::ClouduseraccountsAlpha::LinuxGetAuthorizedKeysViewResponse

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

Parameters:

  • project (String)

    Project ID for this request.

  • zone (String)

    Name of the zone for this request.

  • user (String)

    The user account for which you want to get a list of authorized public keys.

  • instance (String)

    The fully-qualified URL of the virtual machine requesting the view.

  • login (Boolean)

    Whether the view was requested as part of a user-initiated login.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



641
642
643
644
645
646
647
648
649
650
651
652
653
654
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 641

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::ClouduseraccountsAlpha::LinuxGetAuthorizedKeysViewResponse::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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::ClouduseraccountsAlpha::LinuxGetLinuxAccountViewsResponse

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

Parameters:

  • project (String)

    Project ID for this request.

  • zone (String)

    Name of the zone for this request.

  • instance (String)

    The fully-qualified URL of the virtual machine requesting the views.

  • filter (String)

    Sets a filter expression for filtering listed resources, in the form filter= expression. Your expression must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example- instance, you would use filter=name ne example-instance. Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values. The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling. automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

  • max_results (Fixnum)

    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

  • order_by (String)

    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

  • page_token (String)

    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 724

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::ClouduseraccountsAlpha::LinuxGetLinuxAccountViewsResponse::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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::ClouduseraccountsAlpha::User

Returns the specified User resource.

Parameters:

  • project (String)

    Project ID for this request.

  • user (String)

    Name of the user resource to return.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



847
848
849
850
851
852
853
854
855
856
857
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 847

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::ClouduseraccountsAlpha::User::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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

#get_user_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsAlpha::Policy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters:

  • project (String)

    Project ID for this request.

  • resource (String)

    Name of the resource for this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_user_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/global/users/{resource}/getIamPolicy', options)
  command.response_representation = Google::Apis::ClouduseraccountsAlpha::Policy::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::Policy
  command.params['project'] = project unless project.nil?
  command.params['resource'] = resource unless resource.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::ClouduseraccountsAlpha::Operation

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

Parameters:

  • project (String)

    Project ID for this request.

  • group_object (Google::Apis::ClouduseraccountsAlpha::Group) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



393
394
395
396
397
398
399
400
401
402
403
404
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 393

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::ClouduseraccountsAlpha::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::ClouduseraccountsAlpha::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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::ClouduseraccountsAlpha::Operation

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

Parameters:

  • project (String)

    Project ID for this request.

  • user_object (Google::Apis::ClouduseraccountsAlpha::User) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



924
925
926
927
928
929
930
931
932
933
934
935
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 924

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::ClouduseraccountsAlpha::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::ClouduseraccountsAlpha::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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::ClouduseraccountsAlpha::OperationList

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

Parameters:

  • project (String)

    Project ID for this request.

  • filter (String)

    Sets a filter expression for filtering listed resources, in the form filter= expression. Your expression must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example- instance, you would use filter=name ne example-instance. Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values. The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling. automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

  • max_results (Fixnum)

    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

  • order_by (String)

    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

  • page_token (String)

    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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::ClouduseraccountsAlpha::OperationList::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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::ClouduseraccountsAlpha::GroupList

Retrieves the list of groups contained within the specified project.

Parameters:

  • project (String)

    Project ID for this request.

  • filter (String)

    Sets a filter expression for filtering listed resources, in the form filter= expression. Your expression must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example- instance, you would use filter=name ne example-instance. Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values. The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling. automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

  • max_results (Fixnum)

    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

  • order_by (String)

    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

  • page_token (String)

    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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::ClouduseraccountsAlpha::GroupList::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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::ClouduseraccountsAlpha::UserList

Retrieves a list of users contained within the specified project.

Parameters:

  • project (String)

    Project ID for this request.

  • filter (String)

    Sets a filter expression for filtering listed resources, in the form filter= expression. Your expression must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example- instance, you would use filter=name ne example-instance. Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values. The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling. automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

  • max_results (Fixnum)

    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

  • order_by (String)

    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

  • page_token (String)

    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 1001

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::ClouduseraccountsAlpha::UserList::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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::ClouduseraccountsAlpha::Operation

Removes users from the specified group.

Parameters:

  • project (String)

    Project ID for this request.

  • group_name (String)

    Name of the group for this request.

  • groups_remove_member_request_object (Google::Apis::ClouduseraccountsAlpha::GroupsRemoveMemberRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



512
513
514
515
516
517
518
519
520
521
522
523
524
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 512

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::ClouduseraccountsAlpha::GroupsRemoveMemberRequest::Representation
  command.request_object = groups_remove_member_request_object
  command.response_representation = Google::Apis::ClouduseraccountsAlpha::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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::ClouduseraccountsAlpha::Operation

Removes the specified public key from the user.

Parameters:

  • project (String)

    Project ID for this request.

  • user (String)

    Name of the user for this request.

  • fingerprint (String)

    The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 1046

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::ClouduseraccountsAlpha::Operation::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::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

#set_group_iam_policy(project, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsAlpha::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • project (String)

    Project ID for this request.

  • resource (String)

    Name of the resource for this request.

  • policy_object (Google::Apis::ClouduseraccountsAlpha::Policy) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



554
555
556
557
558
559
560
561
562
563
564
565
566
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 554

def set_group_iam_policy(project, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/groups/{resource}/setIamPolicy', options)
  command.request_representation = Google::Apis::ClouduseraccountsAlpha::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::ClouduseraccountsAlpha::Policy::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::Policy
  command.params['project'] = project unless project.nil?
  command.params['resource'] = resource unless resource.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

#set_user_iam_policy(project, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsAlpha::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • project (String)

    Project ID for this request.

  • resource (String)

    Name of the resource for this request.

  • policy_object (Google::Apis::ClouduseraccountsAlpha::Policy) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 1087

def set_user_iam_policy(project, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/users/{resource}/setIamPolicy', options)
  command.request_representation = Google::Apis::ClouduseraccountsAlpha::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::ClouduseraccountsAlpha::Policy::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::Policy
  command.params['project'] = project unless project.nil?
  command.params['resource'] = resource unless resource.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

#test_group_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsAlpha::TestPermissionsResponse

Returns permissions that a caller has on the specified resource.

Parameters:

  • project (String)

    Project ID for this request.

  • resource (String)

    Name of the resource for this request.

  • test_permissions_request_object (Google::Apis::ClouduseraccountsAlpha::TestPermissionsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



595
596
597
598
599
600
601
602
603
604
605
606
607
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 595

def test_group_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/groups/{resource}/testIamPermissions', options)
  command.request_representation = Google::Apis::ClouduseraccountsAlpha::TestPermissionsRequest::Representation
  command.request_object = test_permissions_request_object
  command.response_representation = Google::Apis::ClouduseraccountsAlpha::TestPermissionsResponse::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::TestPermissionsResponse
  command.params['project'] = project unless project.nil?
  command.params['resource'] = resource unless resource.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

#test_user_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouduseraccountsAlpha::TestPermissionsResponse

Returns permissions that a caller has on the specified resource.

Parameters:

  • project (String)

    Project ID for this request.

  • resource (String)

    Name of the resource for this request.

  • test_permissions_request_object (Google::Apis::ClouduseraccountsAlpha::TestPermissionsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
# File 'generated/google/apis/clouduseraccounts_alpha/service.rb', line 1128

def test_user_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/users/{resource}/testIamPermissions', options)
  command.request_representation = Google::Apis::ClouduseraccountsAlpha::TestPermissionsRequest::Representation
  command.request_object = test_permissions_request_object
  command.response_representation = Google::Apis::ClouduseraccountsAlpha::TestPermissionsResponse::Representation
  command.response_class = Google::Apis::ClouduseraccountsAlpha::TestPermissionsResponse
  command.params['project'] = project unless project.nil?
  command.params['resource'] = resource unless resource.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