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

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

Overview

Cloud Identity API

API for provisioning and managing identity resources.

Examples:

require 'google/apis/cloudidentity_v1beta1'

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

See Also:

Instance Attribute Summary collapse

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

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

Instance Method Summary collapse

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

#batch, #batch_upload, #fetch_all, #http

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

#logger

Constructor Details

#initialize ⇒ CloudIdentityService

Returns a new instance of CloudIdentityService.



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

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

Instance Attribute Details

#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.



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

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.



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

def quota_user
  @quota_user
end

Instance Method Details

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

Creates a Group.

Parameters:

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

    Required. The initial configuration option for the Group.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



71
72
73
74
75
76
77
78
79
80
81
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 71

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

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

Creates a Membership.

Parameters:

  • parent (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



358
359
360
361
362
363
364
365
366
367
368
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 358

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

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

Deletes a Group.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

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

Deletes a Membership.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

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

Retrieves a Group.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



139
140
141
142
143
144
145
146
147
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 139

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

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

Retrieves a Membership.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

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

Lists the Memberships within a Group.

Parameters:

  • parent (String) —

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

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

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

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

Lists the Groups under a customer or namespace.

Parameters:

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

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

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

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

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

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

Parameters:

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



231
232
233
234
235
236
237
238
239
240
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 231

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

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

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

Parameters:

  • parent (String) —

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



525
526
527
528
529
530
531
532
533
534
535
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 525

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

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

Modifies the MembershipRoles of a Membership.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



561
562
563
564
565
566
567
568
569
570
571
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 561

def modify_membership_roles(name, modify_membership_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:modifyMembershipRoles', options)
  command.request_representation = Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesRequest::Representation
  command.request_object = modify_membership_roles_request_object
  command.response_representation = Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse::Representation
  command.response_class = Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Updates a Group.

Parameters:

  • name (String) —

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 269

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

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

Searches for Groups matching a specified query.

Parameters:

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

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

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

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 323

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