Class: Google::Apis::CloudidentityV1beta1::CloudIdentityService

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

Overview

Cloud Identity API

API for provisioning and managing identity resources.

Examples:

require 'google/apis/cloudidentity_v1beta1'

Cloudidentity = Google::Apis::CloudidentityV1beta1 # Alias the module
service = Cloudidentity::CloudIdentityService.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

#initializeCloudIdentityService

Returns a new instance of CloudIdentityService.


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

def initialize
  super('https://cloudidentity.googleapis.com/', '')
  @batch_path = 'batch'
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.


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

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.

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.


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

def quota_user
  @quota_user
end

Instance Method Details

#approve_device_user(name, approve_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Approves device to access user data.

Parameters:

  • name (String)

    Required. Resource name of the Device in format: devices/device_id/deviceUsers/device_user_id``, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

  • approve_device_user_request_object (Google::Apis::CloudidentityV1beta1::ApproveDeviceUserRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


309
310
311
312
313
314
315
316
317
318
319
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 309

def approve_device_user(name, approve_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:approve', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::ApproveDeviceUserRequest::Representation
  command.request_object = approve_device_user_request_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  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

#block_device_user(name, block_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Blocks device from accessing user data

Parameters:

  • name (String)

    Required. Resource name of the Device in format: devices/device_id/deviceUsers/device_user_id``, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

  • block_device_user_request_object (Google::Apis::CloudidentityV1beta1::BlockDeviceUserRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


345
346
347
348
349
350
351
352
353
354
355
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 345

def block_device_user(name, block_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:block', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::BlockDeviceUserRequest::Representation
  command.request_object = block_device_user_request_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  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

#cancel_wipe_device(name, cancel_wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped.

Parameters:

  • name (String)

    Required. Resource name of the Device in format: devices/device_id``, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

  • cancel_wipe_device_request_object (Google::Apis::CloudidentityV1beta1::CancelWipeDeviceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


76
77
78
79
80
81
82
83
84
85
86
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 76

def cancel_wipe_device(name, cancel_wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancelWipe', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::CancelWipeDeviceRequest::Representation
  command.request_object = cancel_wipe_device_request_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  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

#cancel_wipe_device_user(name, cancel_wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped.

Parameters:

  • name (String)

    Required. Resource name of the Device in format: devices/device_id/deviceUsers/device_user_id``, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

  • cancel_wipe_device_user_request_object (Google::Apis::CloudidentityV1beta1::CancelWipeDeviceUserRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


383
384
385
386
387
388
389
390
391
392
393
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 383

def cancel_wipe_device_user(name, cancel_wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancelWipe', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::CancelWipeDeviceUserRequest::Representation
  command.request_object = cancel_wipe_device_user_request_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  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

#create_device(create_device_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Creates a device. Only company-owned device may be created.

Parameters:

  • create_device_request_object (Google::Apis::CloudidentityV1beta1::CreateDeviceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def create_device(create_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/devices', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::CreateDeviceRequest::Representation
  command.request_object = create_device_request_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_group(group_object = nil, initial_group_config: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Creates a Group.

Parameters:

  • group_object (Google::Apis::CloudidentityV1beta1::Group) (defaults to: nil)
  • initial_group_config (String) (defaults to: nil)

    Required. The initial configuration option for the Group.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


746
747
748
749
750
751
752
753
754
755
756
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 746

def create_group(group_object = nil, initial_group_config: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/groups', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  command.query['initialGroupConfig'] = initial_group_config unless initial_group_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_group_membership(parent, membership_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Creates a Membership.

Parameters:

  • parent (String)

    Required. The parent Group resource under which to create the Membership. Must be of the form groups/group_id``.

  • membership_object (Google::Apis::CloudidentityV1beta1::Membership) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 1017

def create_group_membership(parent, membership_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/memberships', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::Membership::Representation
  command.request_object = membership_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_device(name, customer: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Deletes the specified device.

Parameters:

  • name (String)

    Required. Resource name of the Device in format: devices/device_id``, where device_id is the unique ID assigned to the Device.

  • customer (String) (defaults to: nil)

    Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/customer_id``, where customer_id is the customer to whom the device belongs.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


146
147
148
149
150
151
152
153
154
155
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 146

def delete_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Deletes the specified DeviceUser. This also revokes the user's access to device data.

Parameters:

  • name (String)

    Required. Resource name of the Device in format: devices/device_id/deviceUsers/device_user_id``, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

  • customer (String) (defaults to: nil)

    Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/customer_id``, where customer_id is the customer to whom the device belongs.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


425
426
427
428
429
430
431
432
433
434
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 425

def delete_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_group(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Deletes a Group.

Parameters:

  • name (String)

    Required. The resource name of the Group to retrieve. Must be of the form groups/ group_id``.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


780
781
782
783
784
785
786
787
788
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 780

def delete_group(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  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

#delete_group_membership(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Deletes a Membership.

Parameters:

  • name (String)

    Required. The resource name of the Membership to delete. Must be of the form groups/ group_id/memberships/membership_id``.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1051
1052
1053
1054
1055
1056
1057
1058
1059
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 1051

def delete_group_membership(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  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

#get_device(name, customer: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Device

Retrieves the specified device.

Parameters:

  • name (String)

    Required. Resource name of the Device in format: devices/device_id``, where device_id is the unique ID assigned to the Device.

  • customer (String) (defaults to: nil)

    Required. Resource name of the Customer in format: customers/customer_id``, where customer_id is the customer to whom the device belongs.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


183
184
185
186
187
188
189
190
191
192
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 183

def get_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::Device::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Device
  command.params['name'] = name unless name.nil?
  command.query['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::DeviceUser

Retrieves the specified DeviceUser

Parameters:

  • name (String)

    Required. Resource name of the Device in format: devices/device_id/deviceUsers/device_user_id``, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

  • customer (String) (defaults to: nil)

    Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/customer_id``, where customer_id is the customer to whom the device belongs.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


465
466
467
468
469
470
471
472
473
474
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 465

def get_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::DeviceUser::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::DeviceUser
  command.params['name'] = name unless name.nil?
  command.query['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_device_device_user_client_state(name, customer: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::ClientState

Gets the client state for the device user

Parameters:

  • name (String)

    Required. Resource name of the ClientState in format: devices/device_id/deviceUsers/device_user_id /clientStates/partner_id``, where device_id is the unique ID assigned to the Device, device_user_id is the unique ID assigned to the User and partner_id identifies the partner storing the data.

  • customer (String) (defaults to: nil)

    Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/customer_id``, where customer_id is the customer to whom the device belongs.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


667
668
669
670
671
672
673
674
675
676
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 667

def get_device_device_user_client_state(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::ClientState::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::ClientState
  command.params['name'] = name unless name.nil?
  command.query['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_group(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Group

Retrieves a Group.

Parameters:

  • name (String)

    Required. The resource name of the Group to retrieve. Must be of the form groups/ group_id``.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


812
813
814
815
816
817
818
819
820
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 812

def get_group(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::Group::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Group
  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

#get_group_membership(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Membership

Retrieves a Membership.

Parameters:

  • name (String)

    Required. The resource name of the Membership to retrieve. Must be of the form groups/ group_id/memberships/membership_id``.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1083
1084
1085
1086
1087
1088
1089
1090
1091
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 1083

def get_group_membership(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::Membership::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Membership
  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

#list_device_device_users(parent, customer: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse

Lists/Searches DeviceUsers.

Parameters:

  • parent (String)

    Required. To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/device

  • customer (String) (defaults to: nil)

    Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/customer_id``, where customer_id is the customer to whom the device belongs.

  • filter (String) (defaults to: nil)

    Optional. Additional restrictions when fetching list of devices. HC article

  • order_by (String) (defaults to: nil)

    Optional. Order specification for devices in the response.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of DeviceUsers to return. If unspecified, at most 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListDeviceUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def list_device_device_users(parent, customer: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/deviceUsers', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['customer'] = customer unless customer.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_devices(customer: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::ListDevicesResponse

Lists/Searches devices.

Parameters:

  • customer (String) (defaults to: nil)

    Required. Resource name of the customer.

  • filter (String) (defaults to: nil)

    Optional. Additional restrictions when fetching list of devices. HC article link

  • order_by (String) (defaults to: nil)

    Optional. Order specification for devices in the response. Only one of the following field names may be used to specify the order: create_time, last_sync_time, model, os_version, device_type and serial_number. desc may be specified optionally to specify results to be sorted in descending order. Default order is ascending.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of Devices to return. If unspecified, at most 20 Devices will be returned. The maximum value is 100; values above 100 will be coerced to 100.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListDevices call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDevices must match the call that provided the page token.

  • view (String) (defaults to: nil)

    Optional. The view to use for the List request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


234
235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 234

def list_devices(customer: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/devices', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::ListDevicesResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::ListDevicesResponse
  command.query['customer'] = customer unless customer.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_group_memberships(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::ListMembershipsResponse

Lists the Memberships within a Group.

Parameters:

  • parent (String)

    Required. The parent Group resource under which to lookup the Membership name. Must be of the form groups/group_id``.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a next_page_token. If unspecified, defaults to 200 for GroupView.BASIC and to 50 for GroupView.FULL. Must not be greater than 1000 for GroupView.BASIC or 500 for GroupView.FULL.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous search request, if any.

  • view (String) (defaults to: nil)

    The level of detail to be returned. If unspecified, defaults to MembershipView.BASIC.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 1126

def list_group_memberships(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/memberships', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::ListMembershipsResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::ListMembershipsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_groups(page_size: nil, page_token: nil, parent: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::ListGroupsResponse

Lists the Groups under a customer or namespace.

Parameters:

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a next_page_token. If unspecified, defaults to 200 for View.BASIC and to 50 for View.FULL. Must not be greater than 1000 for View.BASIC or 500 for View.FULL.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request, if any.

  • parent (String) (defaults to: nil)

    Required. The parent resource under which to list all Groups. Must be of the form identitysources/identity_source_idfor external- identity-mapped groups or `customers/`customer_id for Google Groups.

  • view (String) (defaults to: nil)

    The level of detail to be returned. If unspecified, defaults to View.BASIC.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


855
856
857
858
859
860
861
862
863
864
865
866
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 855

def list_groups(page_size: nil, page_token: nil, parent: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/groups', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::ListGroupsResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::ListGroupsResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_device_device_user(parent, android_id: nil, page_size: nil, page_token: nil, raw_resource_id: nil, user_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www. googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the ' raw_resource_id' field is required.

Parameters:

  • parent (String)

    Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user.

  • android_id (String) (defaults to: nil)

    Android Id returned by Settings.Secure#ANDROID_ID.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous LookupDeviceUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to LookupDeviceUsers must match the call that provided the page token.

  • raw_resource_id (String) (defaults to: nil)

    Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the ' device_resource_id' field in the following platform dependent files. Mac: ~/. secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%. secureConnect\context_aware_config.json Linux: ~/.secureConnect/ context_aware_config.json

  • user_id (String) (defaults to: nil)

    The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the DeviceUser's resource name for the calling user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


586
587
588
589
590
591
592
593
594
595
596
597
598
599
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 586

def lookup_device_device_user(parent, android_id: nil, page_size: nil, page_token: nil, raw_resource_id: nil, user_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}:lookup', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['androidId'] = android_id unless android_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['rawResourceId'] = raw_resource_id unless raw_resource_id.nil?
  command.query['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_group(group_key_id: nil, group_key_namespace: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::LookupGroupNameResponse

Looks up the resource name of a Group by its EntityKey.

Parameters:

  • group_key_id (String) (defaults to: nil)

    The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.

  • group_key_namespace (String) (defaults to: nil)

    The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/identity_source_id`.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


898
899
900
901
902
903
904
905
906
907
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 898

def lookup_group(group_key_id: nil, group_key_namespace: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/groups:lookup', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::LookupGroupNameResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::LookupGroupNameResponse
  command.query['groupKey.id'] = group_key_id unless group_key_id.nil?
  command.query['groupKey.namespace'] = group_key_namespace unless group_key_namespace.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_group_membership(parent, member_key_id: nil, member_key_namespace: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::LookupMembershipNameResponse

Looks up the resource name of a Membership by its EntityKey.

Parameters:

  • parent (String)

    Required. The parent Group resource under which to lookup the Membership name. Must be of the form groups/group_id``.

  • member_key_id (String) (defaults to: nil)

    The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.

  • member_key_namespace (String) (defaults to: nil)

    The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/identity_source_id`.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 1172

def lookup_group_membership(parent, member_key_id: nil, member_key_namespace: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/memberships:lookup', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::LookupMembershipNameResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::LookupMembershipNameResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['memberKey.id'] = member_key_id unless member_key_id.nil?
  command.query['memberKey.namespace'] = member_key_namespace unless member_key_namespace.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#modify_membership_roles(name, modify_membership_roles_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse

Modifies the MembershipRoles of a Membership.

Parameters:

  • name (String)

    Required. The resource name of the Membership whose roles are to be modified. Must be of the form groups/group_id/memberships/membership_id``.

  • modify_membership_roles_request_object (Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 1207

def modify_membership_roles(name, modify_membership_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:modifyMembershipRoles', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesRequest::Representation
  command.request_object = modify_membership_roles_request_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse
  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

#patch_device_device_user_client_state(name, client_state_object = nil, customer: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Updates the client state for the device user

Parameters:

  • name (String)

    Output only. Resource name of the ClientState in format: devices/device_id/deviceUsers/ device_user_id/clientState/partner_id``, where partner_id corresponds to the partner storing the data.

  • client_state_object (Google::Apis::CloudidentityV1beta1::ClientState) (defaults to: nil)
  • customer (String) (defaults to: nil)

    Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/customer_id``, where customer_id is the customer to whom the device belongs.

  • update_mask (String) (defaults to: nil)

    Optional. Comma-separated list of fully qualified names of fields to be updated. If not specified, all updatable fields in ClientState are updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


711
712
713
714
715
716
717
718
719
720
721
722
723
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 711

def patch_device_device_user_client_state(name, client_state_object = nil, customer: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::ClientState::Representation
  command.request_object = client_state_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['customer'] = customer unless customer.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_group(name, group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Updates a Group.

Parameters:

  • name (String)

    Output only. The resource name of the Group. Shall be of the form groups/group_id``.

  • group_object (Google::Apis::CloudidentityV1beta1::Group) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The fully-qualified names of fields to update. May only contain the following fields: display_name, description.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


934
935
936
937
938
939
940
941
942
943
944
945
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 934

def patch_group(name, group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_groups(page_size: nil, page_token: nil, query: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::SearchGroupsResponse

Searches for Groups matching a specified query.

Parameters:

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a next_page_token. If unspecified, defaults to 200 for GroupView.BASIC and to 50 for GroupView.FULL. Must not be greater than 1000 for GroupView.BASIC or 500 for GroupView.FULL.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous search request, if any.

  • query (String) (defaults to: nil)

    Required. The search query. Must be specified in Common Expression Language. May only contain equality operators on the parent and inclusion operators on labels (e.g., parent == 'customers/ customer_id' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels).

  • view (String) (defaults to: nil)

    The level of detail to be returned. If unspecified, defaults to View.BASIC.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


982
983
984
985
986
987
988
989
990
991
992
993
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 982

def search_groups(page_size: nil, page_token: nil, query: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/groups:search', options)
  command.response_representation = Google::Apis::CloudidentityV1beta1::SearchGroupsResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::SearchGroupsResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wipe_device(name, wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Wipes all data on the specified device.

Parameters:

  • name (String)

    Required. Resource name of the Device in format: devices/device_id/deviceUsers/device_user_id``, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

  • wipe_device_request_object (Google::Apis::CloudidentityV1beta1::WipeDeviceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


273
274
275
276
277
278
279
280
281
282
283
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 273

def wipe_device(name, wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wipe', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::WipeDeviceRequest::Representation
  command.request_object = wipe_device_request_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  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

#wipe_device_user(name, wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1beta1::Operation

Wipes the user's account on a device.

Parameters:

  • name (String)

    Required. Resource name of the Device in format: devices/device_id/deviceUsers/device_user_id``, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

  • wipe_device_user_request_object (Google::Apis::CloudidentityV1beta1::WipeDeviceUserRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


625
626
627
628
629
630
631
632
633
634
635
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 625

def wipe_device_user(name, wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wipe', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::WipeDeviceUserRequest::Representation
  command.request_object = wipe_device_user_request_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
  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