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, 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)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def create_group(group_object = 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['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) —

    Resource name of the Group to create Membership within. Format: groups/group_id`, where group_id` is the unique id assigned to the Group.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



296
297
298
299
300
301
302
303
304
305
306
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 296

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

    Resource name of the Group in the format: groups/group_id`, wheregroup_id` is the unique id assigned to the Group.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



102
103
104
105
106
107
108
109
110
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 102

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

    Resource name of the Membership to be deleted. Format: groups/group_id/memberships/member_id`, wheregroup_id` is the unique id assigned to the Group to which Membership belongs to, and member_id is the unique id assigned to the member.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



332
333
334
335
336
337
338
339
340
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 332

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

    Resource name of the Group in the format: groups/group_id`, wheregroup_id` is the unique id assigned to the Group.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



134
135
136
137
138
139
140
141
142
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 134

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

    Resource name of the Membership to be retrieved. Format: groups/group_id/memberships/member_id`, wheregroup_idis the unique id assigned to the Group to which Membership belongs to, and member_id` is the unique id assigned to the member.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



366
367
368
369
370
371
372
373
374
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 366

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

List Memberships within a Group.

Parameters:

  • parent (String) —

    Resource name of the Group to list Memberships within. Format: groups/group_id`, wheregroup_id` is the unique id assigned to the Group.

  • page_size (Fixnum) —

    Maximum number of Memberships to return. MembershipView | Default | Maximum -------------- | ------- | ------- BASIC | 200 | 1000 FULL | 50 | 500

  • page_token (String) —

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

  • view (String) —

    Membership resource view to be returned. Defaults to MembershipView.BASIC.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 409

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

#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 resource name of a Group by its EntityKey.

Parameters:

  • group_key_id (String) —

    The id of the entity within the given namespace. The id must be unique within its namespace.

  • group_key_namespace (String) —

    Namespaces provide isolation for ids, i.e an id only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace "identitysources/identity_source_id" is created corresponding to every Identity Source identity_source_id.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



173
174
175
176
177
178
179
180
181
182
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 173

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 resource name of a Membership within a Group by member's EntityKey.

Parameters:

  • parent (String) —

    Resource name of the Group to lookup Membership within. Format: groups/group_id`, wheregroup_id` is the unique id assigned to the Group.

  • member_key_id (String) —

    The id of the entity within the given namespace. The id must be unique within its namespace.

  • member_key_namespace (String) —

    Namespaces provide isolation for ids, i.e an id only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace "identitysources/identity_source_id" is created corresponding to every Identity Source identity_source_id.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



456
457
458
459
460
461
462
463
464
465
466
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 456

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

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

    Resource name of the Group in the format: groups/group_id``, where group_id is the unique id assigned to the Group. Must be left blank while creating a Group

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

    Editable fields: display_name, description

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 210

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.

Parameters:

  • page_size (Fixnum) —

    The max number of groups to return. GroupView | Default | Maximum --------- | ------- | ------- BASIC | 200 | 1000 FULL | 50 | 500

  • page_token (String) —

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

  • query (String) —

    Query string for performing search on groups. Users can search on namespace and label attributes of groups. EXACT match ('=') is supported on namespace, and CONTAINS match (':') is supported on labels. This is a required field. Multiple queries can be combined using AND operator. The operator is case sensitive. An example query would be: "namespace= AND labels:".

  • view (String) —

    Group resource view to be returned. Defaults to GroupView.BASIC.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'generated/google/apis/cloudidentity_v1beta1/service.rb', line 260

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