google-api-client 0.36.0 → 0.37.0

data/generated/google/apis/cloudidentity_v1beta1/service.rb

@@ -47,8 +47,10 @@ module Google
           @batch_path = 'batch'
         end
         
-        # Creates a Group.
+        # Creates a `Group`.
         # @param [Google::Apis::CloudidentityV1beta1::Group] group_object
+        # @param [String] initial_group_config
+        #   Required. The initial configuration option for the `Group`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -66,22 +68,24 @@ module Google
         # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def create_group(group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+        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
         
-        # Deletes a Group.
+        # Deletes a `Group`.
         # @param [String] name
-        #   [Resource name](https://cloud.google.com/apis/design/resource_names) of the
-        #   Group in the format: `groups/`group_id``, where `group_id` is the unique id
-        #   assigned to the Group.
+        #   Required. The [resource name](https://cloud.google.com/apis/design/
+        #   resource_names) of
+        #   the `Group` to retrieve.
+        #   Must be of the form `groups/`group_id``.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -109,11 +113,12 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves a Group.
+        # Retrieves a `Group`.
         # @param [String] name
-        #   [Resource name](https://cloud.google.com/apis/design/resource_names) of the
-        #   Group in the format: `groups/`group_id``, where `group_id` is the unique id
-        #   assigned to the Group.
+        #   Required. The [resource name](https://cloud.google.com/apis/design/
+        #   resource_names) of
+        #   the `Group` to retrieve.
+        #   Must be of the form `groups/`group_id``.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -141,18 +146,71 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Looks up [resource
-        # name](https://cloud.google.com/apis/design/resource_names) of a Group by
-        # its EntityKey.
+        # Lists the `Group`s under a customer or namespace.
+        # @param [Fixnum] page_size
+        #   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`.
+        # @param [String] page_token
+        #   The `next_page_token` value returned from a previous list request, if any.
+        # @param [String] parent
+        #   Required. The parent resource under which to list all `Group`s.
+        #   Must be of the form `identitysources/`identity_source_id`` for external-
+        #   identity-mapped groups or `customers/`customer_id`` for Google Groups.
+        # @param [String] view
+        #   The level of detail to be returned.
+        #   If unspecified, defaults to `View.BASIC`.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::CloudidentityV1beta1::ListGroupsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::CloudidentityV1beta1::ListGroupsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        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
+        
+        # Looks up the [resource
+        # name](https://cloud.google.com/apis/design/resource_names) of a `Group` by
+        # its `EntityKey`.
         # @param [String] group_key_id
-        #   The id of the entity within the given namespace. The id must be unique
-        #   within its namespace.
+        #   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`.
         # @param [String] group_key_namespace
-        #   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`.
+        #   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`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -181,16 +239,16 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Updates a Group.
+        # Updates a `Group`.
         # @param [String] name
-        #   Output only. [Resource name](https://cloud.google.com/apis/design/
-        #   resource_names) 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
+        #   Output only. The [resource name](https://cloud.google.com/apis/design/
+        #   resource_names) of
+        #   the `Group`.
+        #   Shall be of the form `groups/`group_id``.
         # @param [Google::Apis::CloudidentityV1beta1::Group] group_object
         # @param [String] update_mask
-        #   Editable fields: `display_name`, `description`
+        #   Required. The fully-qualified names of fields to update.
+        #   May only contain the following fields: `display_name`, `description`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -221,23 +279,30 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Searches for Groups.
+        # Searches for `Group`s matching a specified query.
         # @param [Fixnum] page_size
-        #   The default page size is 200 (max 1000) for the BASIC view, and 50
-        #   (max 500) for the FULL view.
+        #   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`.
         # @param [String] page_token
-        #   The next_page_token value returned from a previous search request, if any.
+        #   The `next_page_token` value returned from a previous search request, if
+        #   any.
         # @param [String] query
-        #   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=<namespace_value> AND labels:<labels_value>".
+        #   Required. The search query.
+        #   Must be specified in [Common Expression
+        #   Language](https://opensource.google/projects/cel). 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`).
         # @param [String] view
-        #   Group resource view to be returned. Defaults to [GroupView.BASIC]().
+        #   The level of detail to be returned.
+        #   If unspecified, defaults to `View.BASIC`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -268,11 +333,10 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Creates a Membership.
+        # Creates a `Membership`.
         # @param [String] parent
-        #   [Resource name](https://cloud.google.com/apis/design/resource_names) of the
-        #   Group to create Membership within. Format: `groups/`group_id``, where
-        #   `group_id` is the unique id assigned to the Group.
+        #   Required. The parent `Group` resource under which to create the `Membership`.
+        #   Must be of the form `groups/`group_id``.
         # @param [Google::Apis::CloudidentityV1beta1::Membership] membership_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -303,13 +367,12 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Deletes a Membership.
+        # Deletes a `Membership`.
         # @param [String] name
-        #   [Resource name](https://cloud.google.com/apis/design/resource_names) of the
-        #   Membership to be deleted.
-        #   Format: `groups/`group_id`/memberships/`member_id``, where `group_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.
+        #   Required. The [resource name](https://cloud.google.com/apis/design/
+        #   resource_names) of
+        #   the `Membership` to delete.
+        #   Must be of the form `groups/`group_id`/memberships/`membership_id``.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -337,13 +400,12 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves a Membership.
+        # Retrieves a `Membership`.
         # @param [String] name
-        #   [Resource name](https://cloud.google.com/apis/design/resource_names) of the
-        #   Membership to be retrieved.
-        #   Format: `groups/`group_id`/memberships/`member_id``, where `group_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.
+        #   Required. The [resource name](https://cloud.google.com/apis/design/
+        #   resource_names) of
+        #   the `Membership` to retrieve.
+        #   Must be of the form `groups/`group_id`/memberships/`membership_id``.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -371,19 +433,27 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # List Memberships within a Group.
+        # Lists the `Membership`s within a `Group`.
         # @param [String] parent
-        #   [Resource name](https://cloud.google.com/apis/design/resource_names) of the
-        #   Group to list Memberships within.
-        #   Format: `groups/`group_id``, where `group_id` is the unique id assigned to
-        #   the Group.
+        #   Required. The parent `Group` resource under which to lookup the `Membership`
+        #   name.
+        #   Must be of the form `groups/`group_id``.
         # @param [Fixnum] page_size
-        #   The default page size is 200 (max 1000) for the BASIC view, and 50
-        #   (max 500) for the FULL view.
+        #   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`.
         # @param [String] page_token
-        #   The next_page_token value returned from a previous list request, if any
+        #   The `next_page_token` value returned from a previous search request, if
+        #   any.
         # @param [String] view
-        #   Membership resource view to be returned. Defaults to MembershipView.BASIC.
+        #   The level of detail to be returned.
+        #   If unspecified, defaults to `MembershipView.BASIC`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -414,23 +484,27 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Looks up [resource
-        # name](https://cloud.google.com/apis/design/resource_names) of a Membership
-        # within a Group by member's EntityKey.
+        # Looks up the [resource
+        # name](https://cloud.google.com/apis/design/resource_names) of a
+        # `Membership` by its `EntityKey`.
         # @param [String] parent
-        #   [Resource name](https://cloud.google.com/apis/design/resource_names) of the
-        #   Group to lookup Membership within.
-        #   Format: `groups/`group_id``, where `group_id` is the unique id assigned to
-        #   the Group.
+        #   Required. The parent `Group` resource under which to lookup the `Membership`
+        #   name.
+        #   Must be of the form `groups/`group_id``.
         # @param [String] member_key_id
-        #   The id of the entity within the given namespace. The id must be unique
-        #   within its namespace.
+        #   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`.
         # @param [String] member_key_namespace
-        #   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`.
+        #   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`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -459,6 +533,42 @@ module Google
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
+        
+        # Modifies the `MembershipRole`s of a `Membership`.
+        # @param [String] name
+        #   Required. The [resource name](https://cloud.google.com/apis/design/
+        #   resource_names) of
+        #   the `Membership` whose roles are to be modified.
+        #   Must be of the form `groups/`group_id`/memberships/`membership_id``.
+        # @param [Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesRequest] modify_membership_roles_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        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
 
         protected
 

data/generated/google/apis/cloudidentity_v1beta1.rb

@@ -25,7 +25,7 @@ module Google
     # @see https://cloud.google.com/identity/
     module CloudidentityV1beta1
       VERSION = 'V1beta1'
-      REVISION = '20191027'
+      REVISION = '20200211'
 
       # See, change, create, and delete any of the Cloud Identity Groups that you can access, including the members of each group
       AUTH_CLOUD_IDENTITY_GROUPS = 'https://www.googleapis.com/auth/cloud-identity.groups'