Class: Google::Apis::CloudidentityV1::CloudIdentityService

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/cloudidentity_v1/service.rb

Overview

Cloud Identity API

API for provisioning and managing identity resources.

Examples:

require 'google/apis/cloudidentity_v1'

Cloudidentity = Google::Apis::CloudidentityV1 # Alias the module
service = Cloudidentity::CloudIdentityService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://cloudidentity.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudIdentityService

Returns a new instance of CloudIdentityService.



47
48
49
50
51
52
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-cloudidentity_v1',
        client_version: Google::Apis::CloudidentityV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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.



40
41
42
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

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.



45
46
47
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#add_idp_credential(parent, add_idp_credential_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Adds an IdpCredential. Up to 2 credentials are allowed. When the target customer has enabled Multi-party approval for sensitive actions, the Operation in the response will have "done": false, it will not have a response, and the metadata will have "state": "awaiting-multi-party-approval".

Parameters:

  • parent (String) —

    Required. The InboundSamlSsoProfile that owns the IdpCredential. Format: inboundSamlSsoProfiles/sso_profile_id``

  • add_idp_credential_request_object (Google::Apis::CloudidentityV1::AddIdpCredentialRequest) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 2074

def add_idp_credential(parent, add_idp_credential_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/idpCredentials:add', options)
  command.request_representation = Google::Apis::CloudidentityV1::AddIdpCredentialRequest::Representation
  command.request_object = add_idp_credential_request_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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

#approve_device_device_user(name, google_apps_cloudidentity_devices_v1_approve_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Approves device to access user data.

Parameters:

  • name (String) —

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

  • google_apps_cloudidentity_devices_v1_approve_device_user_request_object (Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 532

def approve_device_device_user(name, google_apps_cloudidentity_devices_v1_approve_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:approve', options)
  command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest::Representation
  command.request_object = google_apps_cloudidentity_devices_v1_approve_device_user_request_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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_device_user(name, google_apps_cloudidentity_devices_v1_block_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Blocks device from accessing user data

Parameters:

  • name (String) —

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

  • google_apps_cloudidentity_devices_v1_block_device_user_request_object (Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 568

def block_device_device_user(name, google_apps_cloudidentity_devices_v1_block_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:block', options)
  command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest::Representation
  command.request_object = google_apps_cloudidentity_devices_v1_block_device_user_request_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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_device_device_user_wipe(name, google_apps_cloudidentity_devices_v1_cancel_wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::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/deviceUsers/device_user``, where device is the unique ID assigned to the Device, and device_user is the unique ID assigned to the User.

  • google_apps_cloudidentity_devices_v1_cancel_wipe_device_user_request_object (Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 606

def cancel_device_device_user_wipe(name, google_apps_cloudidentity_devices_v1_cancel_wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancelWipe', options)
  command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest::Representation
  command.request_object = google_apps_cloudidentity_devices_v1_cancel_wipe_device_user_request_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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_device_wipe(name, google_apps_cloudidentity_devices_v1_cancel_wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::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. This operation is possible when the device is in a "pending wipe" state. The device enters the "pending wipe" state when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe will fail if the wipe command has already been issued to the device.

Parameters:

  • name (String) —

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

  • google_apps_cloudidentity_devices_v1_cancel_wipe_device_request_object (Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 280

def cancel_device_wipe(name, google_apps_cloudidentity_devices_v1_cancel_wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancelWipe', options)
  command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest::Representation
  command.request_object = google_apps_cloudidentity_devices_v1_cancel_wipe_device_request_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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_userinvitation_user_invitation(name, cancel_user_invitation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Cancels a UserInvitation that was already sent.

Parameters:

  • name (String) —

    Required. UserInvitation name in the format customers/customer/ userinvitations/user_email_address``

  • cancel_user_invitation_request_object (Google::Apis::CloudidentityV1::CancelUserInvitationRequest) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def cancel_userinvitation_user_invitation(name, cancel_user_invitation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::CloudidentityV1::CancelUserInvitationRequest::Representation
  command.request_object = cancel_user_invitation_request_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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

#check_group_membership_transitive_membership(parent, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::CheckTransitiveMembershipResponse

Check a potential member for membership in a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group.

Parameters:

  • parent (String) —

    Resource name of the group to check the transitive membership in. Format: groups/group`, where group` is the unique id assigned to the Group to which the Membership belongs to.

  • query (String) (defaults to: nil) —

    Required. A CEL expression that MUST include member specification. This is a required field. Certain groups are uniquely identified by both a ' member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query: member_key_id == ' member_key_id_value'

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1418

def check_group_membership_transitive_membership(parent, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/memberships:checkTransitiveMembership', options)
  command.response_representation = Google::Apis::CloudidentityV1::CheckTransitiveMembershipResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::CheckTransitiveMembershipResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['query'] = query unless query.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(google_apps_cloudidentity_devices_v1_device_object = nil, customer: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Creates a device. Only company-owned device may be created. Note: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium

Parameters:

  • google_apps_cloudidentity_devices_v1_device_object (Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device) (defaults to: nil)
  • customer (String) (defaults to: nil) —

    Optional. 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``, where customer 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 320

def create_device(google_apps_cloudidentity_devices_v1_device_object = nil, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/devices', options)
  command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device::Representation
  command.request_object = google_apps_cloudidentity_devices_v1_device_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::Operation
  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

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

Creates a Group.

Parameters:

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

    Optional. 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def create_group(group_object = nil, initial_group_config: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/groups', options)
  command.request_representation = Google::Apis::CloudidentityV1::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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::CloudidentityV1::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``.

  • membership_object (Google::Apis::CloudidentityV1::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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1451

def create_group_membership(parent, membership_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/memberships', options)
  command.request_representation = Google::Apis::CloudidentityV1::Membership::Representation
  command.request_object = membership_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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

#create_inbound_saml_sso_profile(inbound_saml_sso_profile_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Creates an InboundSamlSsoProfile for a customer. When the target customer has enabled Multi-party approval for sensitive actions, the Operation in the response will have "done": false, it will not have a response, and the metadata will have "state": " awaiting-multi-party-approval".

Parameters:

  • inbound_saml_sso_profile_object (Google::Apis::CloudidentityV1::InboundSamlSsoProfile) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1885

def create_inbound_saml_sso_profile(inbound_saml_sso_profile_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/inboundSamlSsoProfiles', options)
  command.request_representation = Google::Apis::CloudidentityV1::InboundSamlSsoProfile::Representation
  command.request_object = inbound_saml_sso_profile_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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_inbound_sso_assignment(inbound_sso_assignment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Creates an InboundSsoAssignment for users and devices in a Customer under a given Group or OrgUnit.

Parameters:

  • inbound_sso_assignment_object (Google::Apis::CloudidentityV1::InboundSsoAssignment) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 2211

def create_inbound_sso_assignment(inbound_sso_assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/inboundSsoAssignments', options)
  command.request_representation = Google::Apis::CloudidentityV1::InboundSsoAssignment::Representation
  command.request_object = inbound_sso_assignment_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::Operation
  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::CloudidentityV1::Operation

Deletes the specified device.

Parameters:

  • name (String) —

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

  • customer (String) (defaults to: nil) —

    Optional. 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``, where customer 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



360
361
362
363
364
365
366
367
368
369
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 360

def delete_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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::CloudidentityV1::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/deviceUsers/device_user``, where device is the unique ID assigned to the Device, and device_user is the unique ID assigned to the User.

  • customer (String) (defaults to: nil) —

    Optional. 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``, where customer 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



648
649
650
651
652
653
654
655
656
657
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 648

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

Deletes a Group.

Parameters:

  • name (String) —

    Required. The resource name of the Group to retrieve. Must be of the form groups/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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1081

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

Deletes a Membership.

Parameters:

  • name (String) —

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

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1485

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

Deletes an InboundSamlSsoProfile.

Parameters:

  • name (String) —

    Required. The resource name of the InboundSamlSsoProfile to delete. Format: inboundSamlSsoProfiles/sso_profile_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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1918
1919
1920
1921
1922
1923
1924
1925
1926
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1918

def delete_inbound_saml_sso_profile(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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_inbound_saml_sso_profile_idp_credential(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Deletes an IdpCredential.

Parameters:

  • name (String) —

    Required. The resource name of the IdpCredential to delete. Format: inboundSamlSsoProfiles/sso_profile_id/idpCredentials/idp_credential_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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2108
2109
2110
2111
2112
2113
2114
2115
2116
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 2108

def delete_inbound_saml_sso_profile_idp_credential(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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_inbound_sso_assignment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Deletes an InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has sso_mode == SSO_OFF.

Parameters:

  • name (String) —

    Required. The resource name of the InboundSsoAssignment to delete. Format: inboundSsoAssignments/assignment``

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2245
2246
2247
2248
2249
2250
2251
2252
2253
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 2245

def delete_inbound_sso_assignment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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_customer_userinvitation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::UserInvitation

Retrieves a UserInvitation resource. Note: New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.

Parameters:

  • name (String) —

    Required. UserInvitation name in the format customers/customer/ userinvitations/user_email_address``

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



111
112
113
114
115
116
117
118
119
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 111

def get_customer_userinvitation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1::UserInvitation::Representation
  command.response_class = Google::Apis::CloudidentityV1::UserInvitation
  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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device

Retrieves the specified device.

Parameters:

  • name (String) —

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

  • customer (String) (defaults to: nil) —

    Optional. Resource name of the Customer in the format: customers/customer, where customer is the customer to whom the device belongs. 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, where customer 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



400
401
402
403
404
405
406
407
408
409
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 400

def get_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device::Representation
  command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device
  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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1DeviceUser

Retrieves the specified DeviceUser

Parameters:

  • name (String) —

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

  • customer (String) (defaults to: nil) —

    Optional. 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``, where customer 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



688
689
690
691
692
693
694
695
696
697
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 688

def get_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1DeviceUser::Representation
  command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1DeviceUser
  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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState

Gets the client state for the device user

Parameters:

  • name (String) —

    Required. Resource name of the ClientState in format: devices/device/deviceUsers/device_user/ clientStates/partner, where `device` is the unique ID assigned to the Device, `device_user` is the unique ID assigned to the User and `partner` identifies the partner storing the data. To get the client state for devices belonging to your own organization, the `partnerId` is in the format: ` customerId-*anystring*`. Where the `customerId` is your organization's customer ID and `anystring` is any suffix. This suffix is used in setting up Custom Access Levels in Context-Aware Access. You may use `my_customer` instead of the customer ID for devices managed by your own organization. You may specify `-` in place of thedevice, so the ClientState resource name can be: `devices/-/deviceUsers/`device_user_resource`/clientStates/`partner.

  • customer (String) (defaults to: nil) —

    Optional. 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``, where customer 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



905
906
907
908
909
910
911
912
913
914
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 905

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

Retrieves a Group.

Parameters:

  • name (String) —

    Required. The resource name of the Group to retrieve. Must be of the form groups/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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1113

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

Retrieves a Membership.

Parameters:

  • name (String) —

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

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1517
1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1517

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

#get_group_membership_membership_graph(parent, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Get a membership graph of just a member or both a member and a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 ( PERMISSION_DENIED) HTTP status code will be returned. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member.

Parameters:

  • parent (String) —

    Required. Resource name of the group to search transitive memberships in. Format: groups/group`, wheregroup` is the unique ID assigned to the Group to which the Membership belongs to. group can be a wildcard collection id "-". When a group is specified, the membership graph will be constrained to paths between the member (defined in the query) and the parent. If a wildcard collection is provided, all membership paths connected to the member will be returned.

  • query (String) (defaults to: nil) —

    Required. A CEL expression that MUST include member specification AND label(s). Certain groups are uniquely identified by both a 'member_key_id' and a ' member_key_namespace', which requires an additional query input: ' member_key_namespace'. Example query: member_key_id == 'member_key_id_value' & & in labels

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1566

def get_group_membership_membership_graph(parent, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/memberships:getMembershipGraph', options)
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['query'] = query unless query.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_security_settings(name, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::SecuritySettings

Get Security Settings

Parameters:

  • name (String) —

    Required. The security settings to retrieve. Format: groups/group_id/ securitySettings

  • read_mask (String) (defaults to: nil) —

    Field-level read mask of which fields to return. "*" returns all fields. If not specified, all fields will be returned. May only contain the following field: member_restriction.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1148

def get_group_security_settings(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1::SecuritySettings::Representation
  command.response_class = Google::Apis::CloudidentityV1::SecuritySettings
  command.params['name'] = name unless name.nil?
  command.query['readMask'] = read_mask unless read_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

#get_inbound_saml_sso_profile(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::InboundSamlSsoProfile

Gets an InboundSamlSsoProfile.

Parameters:

  • name (String) —

    Required. The resource name of the InboundSamlSsoProfile to get. Format: inboundSamlSsoProfiles/sso_profile_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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1950
1951
1952
1953
1954
1955
1956
1957
1958
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1950

def get_inbound_saml_sso_profile(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1::InboundSamlSsoProfile::Representation
  command.response_class = Google::Apis::CloudidentityV1::InboundSamlSsoProfile
  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_inbound_saml_sso_profile_idp_credential(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::IdpCredential

Gets an IdpCredential.

Parameters:

  • name (String) —

    Required. The resource name of the IdpCredential to retrieve. Format: inboundSamlSsoProfiles/sso_profile_id/idpCredentials/idp_credential_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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2140
2141
2142
2143
2144
2145
2146
2147
2148
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 2140

def get_inbound_saml_sso_profile_idp_credential(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudidentityV1::IdpCredential::Representation
  command.response_class = Google::Apis::CloudidentityV1::IdpCredential
  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_inbound_sso_assignment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::InboundSsoAssignment

Gets an InboundSsoAssignment.

Parameters:

  • name (String) —

    Required. The resource name of the InboundSsoAssignment to fetch. Format: inboundSsoAssignments/assignment``

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2277
2278
2279
2280
2281
2282
2283
2284
2285
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 2277

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

#is_customer_userinvitation_invitable_user(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::IsInvitableUserResponse

Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email address is a consumer account and it's the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. Note: This method is not supported for Workspace Essentials customers.

Parameters:

  • name (String) —

    Required. UserInvitation name in the format customers/customer/ userinvitations/user_email_address``

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



148
149
150
151
152
153
154
155
156
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 148

def is_customer_userinvitation_invitable_user(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:isInvitableUser', options)
  command.response_representation = Google::Apis::CloudidentityV1::IsInvitableUserResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::IsInvitableUserResponse
  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_customer_userinvitations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::ListUserInvitationsResponse

Retrieves a list of UserInvitation resources. Note: New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.

Parameters:

  • parent (String) —

    Required. The customer ID of the Google Workspace or Cloud Identity account the UserInvitation resources are associated with.

  • filter (String) (defaults to: nil) —

    Optional. A query string for filtering UserInvitation results by their current state, in the format: "state=='invited'".

  • order_by (String) (defaults to: nil) —

    Optional. The sort order of the list results. You can sort the results in descending order based on either email or last update timestamp but not both, using order_by="email desc". Currently, sorting is supported for update_time asc, update_time desc, email asc, and email desc. If not specified, results will be returned based on email asc order.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of UserInvitation resources to return. If unspecified, at most 100 resources will be returned. The maximum value is 200; values above 200 will be set to 200.

  • page_token (String) (defaults to: nil) —

    Optional. A page token, received from a previous ListUserInvitations 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 199

def list_customer_userinvitations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/userinvitations', options)
  command.response_representation = Google::Apis::CloudidentityV1::ListUserInvitationsResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::ListUserInvitationsResponse
  command.params['parent'] = parent unless parent.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_device_device_user_client_states(parent, customer: nil, filter: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListClientStatesResponse

Lists the client states for the given search query.

Parameters:

  • parent (String) —

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

  • customer (String) (defaults to: nil) —

    Optional. 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``, where customer is the customer to whom the device belongs.

  • filter (String) (defaults to: nil) —

    Optional. Additional restrictions when fetching list of client states.

  • order_by (String) (defaults to: nil) —

    Optional. Order specification for client states in the response.

  • page_token (String) (defaults to: nil) —

    Optional. A page token, received from a previous ListClientStates call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListClientStates 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



953
954
955
956
957
958
959
960
961
962
963
964
965
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 953

def list_device_device_user_client_states(parent, customer: nil, filter: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/clientStates', options)
  command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListClientStatesResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListClientStatesResponse
  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['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_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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse

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) —

    Optional. 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``, where customer is the customer to whom the device belongs.

  • filter (String) (defaults to: nil) —

    Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to Mobile device search fields. Multiple search fields are separated by the space character.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 743

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, 'v1/{+parent}/deviceUsers', options)
  command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse
  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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDevicesResponse

Lists/Searches devices.

Parameters:

  • customer (String) (defaults to: nil) —

    Optional. Resource name of the customer in the format: customers/customer, where customer is the customer to whom the device belongs. 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, where customer is the customer to whom the device belongs.

  • filter (String) (defaults to: nil) —

    Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to Mobile device search fields. Multiple search fields are separated by the space character.

  • 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 at the end 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 457

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, 'v1/devices', options)
  command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDevicesResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDevicesResponse
  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::CloudidentityV1::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``.

  • 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 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1609

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, 'v1/{+parent}/memberships', options)
  command.response_representation = Google::Apis::CloudidentityV1::ListMembershipsResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::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::CloudidentityV1::ListGroupsResponse

Lists the Group resources 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 Group resources. Must be of the form identitysources/identity_sourcefor external- identity- mapped groups or `customers/`customer_id for Google Groups. The customer_id must begin with "C" (for example, 'C046psxkn'). Find your customer ID.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1194

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, 'v1/groups', options)
  command.response_representation = Google::Apis::CloudidentityV1::ListGroupsResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::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

#list_inbound_saml_sso_profile_idp_credentials(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::ListIdpCredentialsResponse

Returns a list of IdpCredentials in an InboundSamlSsoProfile.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of IdpCredentials. Format: inboundSamlSsoProfiles/sso_profile_id``

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of IdpCredentials to return. The service may return fewer than this value.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListIdpCredentials call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIdpCredentials 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 2179

def list_inbound_saml_sso_profile_idp_credentials(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/idpCredentials', options)
  command.response_representation = Google::Apis::CloudidentityV1::ListIdpCredentialsResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::ListIdpCredentialsResponse
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_inbound_saml_sso_profiles(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::ListInboundSamlSsoProfilesResponse

Lists InboundSamlSsoProfiles for a customer.

Parameters:

  • filter (String) (defaults to: nil) —

    A Common Expression Language expression to filter the results. The only supported filter is filtering by customer. For example: customer=="customers/C0123abc". Omitting the filter or specifying a filter of customer=="customers/my_customer" will return the profiles for the customer that the caller (authenticated user) belongs to.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of InboundSamlSsoProfiles to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will use a sensible default. This default may change over time. The maximum allowed value is 100. Requests with page_size greater than that will be silently interpreted as having this maximum value.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListInboundSamlSsoProfiles call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListInboundSamlSsoProfiles 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1995

def list_inbound_saml_sso_profiles(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/inboundSamlSsoProfiles', options)
  command.response_representation = Google::Apis::CloudidentityV1::ListInboundSamlSsoProfilesResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::ListInboundSamlSsoProfilesResponse
  command.query['filter'] = filter unless filter.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_inbound_sso_assignments(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::ListInboundSsoAssignmentsResponse

Lists the InboundSsoAssignments for a Customer.

Parameters:

  • filter (String) (defaults to: nil) —

    A CEL expression to filter the results. The only supported filter is filtering by customer. For example: customer==customers/C0123abc. Omitting the filter or specifying a filter of customer==customers/my_customer will return the assignments for the customer that the caller (authenticated user) belongs to.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of assignments to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will use a sensible default. This default may change over time. The maximum allowed value is 100, though requests with page_size greater than that will be silently interpreted as having this maximum value. This may increase in the futue.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListInboundSsoAssignments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListInboundSsoAssignments 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 2321

def list_inbound_sso_assignments(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/inboundSsoAssignments', options)
  command.response_representation = Google::Apis::CloudidentityV1::ListInboundSsoAssignmentsResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::ListInboundSsoAssignmentsResponse
  command.query['filter'] = filter unless filter.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

#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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse

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. * macOS: ~ /.secureConnect/context_aware_config.json * Windows: %USERPROFILE%\AppData\ Local\Google\Endpoint Verification\accounts.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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 811

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, 'v1/{+parent}:lookup', options)
  command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse
  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::CloudidentityV1::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 should be the email address of an existing group or user. Email addresses need to adhere to name guidelines for users and groups. 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``.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1239

def lookup_group(group_key_id: nil, group_key_namespace: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/groups:lookup', options)
  command.response_representation = Google::Apis::CloudidentityV1::LookupGroupNameResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::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::CloudidentityV1::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``.

  • member_key_id (String) (defaults to: nil) —

    The ID of the entity. For Google-managed entities, the id should be the email address of an existing group or user. Email addresses need to adhere to name guidelines for users and groups. 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``.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1657

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, 'v1/{+parent}/memberships:lookup', options)
  command.response_representation = Google::Apis::CloudidentityV1::LookupMembershipNameResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::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::CloudidentityV1::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/memberships/membership``.

  • modify_membership_roles_request_object (Google::Apis::CloudidentityV1::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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1692

def modify_membership_roles(name, modify_membership_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:modifyMembershipRoles', options)
  command.request_representation = Google::Apis::CloudidentityV1::ModifyMembershipRolesRequest::Representation
  command.request_object = modify_membership_roles_request_object
  command.response_representation = Google::Apis::CloudidentityV1::ModifyMembershipRolesResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::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, google_apps_cloudidentity_devices_v1_client_state_object = nil, customer: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Updates the client state for the device user Note: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium

Parameters:

  • name (String) —

    Output only. Resource name of the ClientState in format: devices/device/deviceUsers/ device_user/clientState/partner, where partner corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form:customer-suffix, where customer is your customer ID. The suffix is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: GET https://www.googleapis.com/admin/directory/ v1/customers/my_customer The id field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C')

  • google_apps_cloudidentity_devices_v1_client_state_object (Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState) (defaults to: nil)
  • customer (String) (defaults to: nil) —

    Optional. 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``, where customer 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1012

def patch_device_device_user_client_state(name, google_apps_cloudidentity_devices_v1_client_state_object = nil, customer: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState::Representation
  command.request_object = google_apps_cloudidentity_devices_v1_client_state_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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::CloudidentityV1::Operation

Updates a Group.

Parameters:

  • name (String) —

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

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

    Required. The names of fields to update. May only contain the following field names: display_name, description, labels.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1275

def patch_group(name, group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CloudidentityV1::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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

#patch_inbound_saml_sso_profile(name, inbound_saml_sso_profile_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Updates an InboundSamlSsoProfile. When the target customer has enabled Multi- party approval for sensitive actions, the Operation in the response will have "done": false, it will not have a response, and the metadata will have "state": "awaiting-multi- party-approval".

Parameters:

  • name (String) —

    Output only. Resource name of the SAML SSO profile.

  • inbound_saml_sso_profile_object (Google::Apis::CloudidentityV1::InboundSamlSsoProfile) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The list of fields to be 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 2035

def patch_inbound_saml_sso_profile(name, inbound_saml_sso_profile_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CloudidentityV1::InboundSamlSsoProfile::Representation
  command.request_object = inbound_saml_sso_profile_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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

#patch_inbound_sso_assignment(name, inbound_sso_assignment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Updates an InboundSsoAssignment. The body of this request is the inbound_sso_assignment field and the update_mask is relative to that. For example: a PATCH to /v1/inboundSsoAssignments/0abcdefg1234567&update_mask= rank with a body of "rank": 1 moves that (presumably group-targeted) SSO assignment to the highest priority and shifts any other group-targeted assignments down in priority.

Parameters:

  • name (String) —

    Output only. Resource name of the Inbound SSO Assignment.

  • inbound_sso_assignment_object (Google::Apis::CloudidentityV1::InboundSsoAssignment) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The list of fields to be 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 2362

def patch_inbound_sso_assignment(name, inbound_sso_assignment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CloudidentityV1::InboundSsoAssignment::Representation
  command.request_object = inbound_sso_assignment_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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_group_membership_direct_groups(parent, order_by: nil, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::SearchDirectGroupsResponse

Searches direct groups of a member.

Parameters:

  • parent (String) —

    Resource name of the group to search transitive memberships in. Format: groups/group_id, where group_id is always '-' as this API will search across all groups for a given member.

  • order_by (String) (defaults to: nil) —

    The ordering of membership relation for the display name or email in the response. The syntax for this field can be found at https://cloud.google.com/ apis/design/design_patterns#sorting_order. Example: Sort by the ascending display name: order_by="group_name" or order_by="group_name asc". Sort by the descending display name: order_by="group_name desc". Sort by the ascending group key: order_by="group_key" or order_by="group_key asc". Sort by the descending group key: order_by="group_key desc".

  • page_size (Fixnum) (defaults to: nil) —

    The default page size is 200 (max 1000).

  • page_token (String) (defaults to: nil) —

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

  • query (String) (defaults to: nil) —

    Required. A CEL expression that MUST include member specification AND label(s). Users can search on label attributes of groups. CONTAINS match ('in') is supported on labels. Identity-mapped groups are uniquely identified by both a member_key_id and a member_key_namespace, which requires an additional query input: member_key_namespace. Example query: member_key_id == ' member_key_id_value' && 'label_value' in labels

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1746

def search_group_membership_direct_groups(parent, order_by: nil, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/memberships:searchDirectGroups', options)
  command.response_representation = Google::Apis::CloudidentityV1::SearchDirectGroupsResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::SearchDirectGroupsResponse
  command.params['parent'] = parent unless parent.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['query'] = query unless query.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_group_membership_transitive_groups(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::SearchTransitiveGroupsResponse

Search transitive groups of a member. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.

Parameters:

  • parent (String) —

    Resource name of the group to search transitive memberships in. Format: groups/group`, where group` is always '-' as this API will search across all groups for a given member.

  • page_size (Fixnum) (defaults to: nil) —

    The default page size is 200 (max 1000).

  • page_token (String) (defaults to: nil) —

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

  • query (String) (defaults to: nil) —

    Required. A CEL expression that MUST include member specification AND label(s). This is a required field. Users can search on label attributes of groups. CONTAINS match ('in') is supported on labels. Identity-mapped groups are uniquely identified by both a member_key_id and a member_key_namespace, which requires an additional query input: member_key_namespace. Example query: member_key_id == 'member_key_id_value' && in labels Query may optionally contain equality operators on the parent of the group restricting the search within a particular customer, e.g. parent == 'customers/ customer_id'. The customer_id must begin with "C" (for example, 'C046psxkn' ). This filtering is only supported for Admins with groups read permissons on the input customer. Example query: member_key_id == 'member_key_id_value' && in labels && parent == 'customers/C046psxkn'

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1806

def search_group_membership_transitive_groups(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/memberships:searchTransitiveGroups', options)
  command.response_representation = Google::Apis::CloudidentityV1::SearchTransitiveGroupsResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::SearchTransitiveGroupsResponse
  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['query'] = query unless query.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_group_membership_transitive_memberships(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::SearchTransitiveMembershipsResponse

Search transitive memberships of a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the group is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.

Parameters:

  • parent (String) —

    Resource name of the group to search transitive memberships in. Format: groups/group`, where group` is the unique ID assigned to the Group.

  • page_size (Fixnum) (defaults to: nil) —

    The default page size is 200 (max 1000).

  • page_token (String) (defaults to: nil) —

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

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1850

def search_group_membership_transitive_memberships(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/memberships:searchTransitiveMemberships', options)
  command.response_representation = Google::Apis::CloudidentityV1::SearchTransitiveMembershipsResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::SearchTransitiveMembershipsResponse
  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['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::CloudidentityV1::SearchGroupsResponse

Searches for Group resources 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 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. * Must contain equality operators on the parent, e.g. parent == 'customers/customer_id'. The customer_id must begin with "C" (for example, 'C046psxkn'). Find your customer ID. * Can contain optional inclusion operators on labels such as 'cloudidentity.googleapis.com/groups. discussion_forum' in labels). * Can contain an optional equality operator on domain_name. e.g. domain_name == 'examplepetstore.com' * Can contain optional startsWith/contains/equality operators on group_key, e.g. group_key.startsWith('dev'), group_key.contains('dev'), group_key == 'dev@ examplepetstore.com' * Can contain optional startsWith/contains/equality operators on display_name, such as display_name.startsWith('dev') , display_name.contains('dev'), display_name == 'dev'

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1331

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, 'v1/groups:search', options)
  command.response_representation = Google::Apis::CloudidentityV1::SearchGroupsResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1::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

#send_userinvitation_user_invitation(name, send_user_invitation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Sends a UserInvitation to email. If the UserInvitation does not exist for this request and it is a valid request, the request creates a UserInvitation. Note: The get and list methods have a 48-hour delay where newly- created consumer accounts will not appear in the results. You can still send a UserInvitation to those accounts if you know the unmanaged email address and IsInvitableUser==True.

Parameters:

  • name (String) —

    Required. UserInvitation name in the format customers/customer/ userinvitations/user_email_address``

  • send_user_invitation_request_object (Google::Apis::CloudidentityV1::SendUserInvitationRequest) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 240

def send_userinvitation_user_invitation(name, send_user_invitation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:send', options)
  command.request_representation = Google::Apis::CloudidentityV1::SendUserInvitationRequest::Representation
  command.request_object = send_user_invitation_request_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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

#update_group_security_settings(name, security_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Update Security Settings

Parameters:

  • name (String) —

    Output only. The resource name of the security settings. Shall be of the form groups/group_id/securitySettings.

  • security_settings_object (Google::Apis::CloudidentityV1::SecuritySettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The fully-qualified names of fields to update. May only contain the following field: member_restriction.query.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 1369

def update_group_security_settings(name, security_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CloudidentityV1::SecuritySettings::Representation
  command.request_object = security_settings_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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

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

Wipes all data on the specified device.

Parameters:

  • name (String) —

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

  • google_apps_cloudidentity_devices_v1_wipe_device_request_object (Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1WipeDeviceRequest) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/google/apis/cloudidentity_v1/service.rb', line 496

def wipe_device(name, google_apps_cloudidentity_devices_v1_wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wipe', options)
  command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1WipeDeviceRequest::Representation
  command.request_object = google_apps_cloudidentity_devices_v1_wipe_device_request_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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_device_user(name, google_apps_cloudidentity_devices_v1_wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudidentityV1::Operation

Wipes the user's account on a device. Other data on the device that is not associated with the user's work account is not affected. For example, if a Gmail app is installed on a device that is used for personal and work purposes, and the user is logged in to the Gmail app with their personal account as well as their work account, wiping the "deviceUser" by their work administrator will not affect their personal account within Gmail or other apps such as Photos.

Parameters:

  • name (String) —

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

  • google_apps_cloudidentity_devices_v1_wipe_device_user_request_object (Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def wipe_device_device_user(name, google_apps_cloudidentity_devices_v1_wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wipe', options)
  command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest::Representation
  command.request_object = google_apps_cloudidentity_devices_v1_wipe_device_user_request_object
  command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation
  command.response_class = Google::Apis::CloudidentityV1::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