chiu
/
google-api-ruby-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
google-api-ruby-client/generated/google/apis/cloudidentity_v1/service.rb

1317 lines
85 KiB
Ruby
Raw Normal View History

Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module CloudidentityV1
# Cloud Identity API
#
# API for provisioning and managing identity resources.
#
# @example
# require 'google/apis/cloudidentity_v1'
#
# Cloudidentity = Google::Apis::CloudidentityV1 # Alias the module
# service = Cloudidentity::CloudIdentityService.new
#
# @see https://cloud.google.com/identity/
class CloudIdentityService < Google::Apis::Core::BaseService
# @return [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.
attr_accessor :key
# @return [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.
attr_accessor :quota_user
def initialize
super('https://cloudidentity.googleapis.com/', '')
@batch_path = 'batch'
end
Autogenerated update (2020-09-14) Update: - accessapproval_v1 - accesscontextmanager_v1 - accesscontextmanager_v1beta - admin_directory_v1 - admob_v1 - analyticsreporting_v4 - androidpublisher_v3 - appengine_v1 - appengine_v1beta - bigquery_v2 - bigtableadmin_v1 - bigtableadmin_v2 - binaryauthorization_v1 - binaryauthorization_v1beta1 - calendar_v3 - civicinfo_v2 - cloudasset_v1 - cloudasset_v1beta1 - cloudasset_v1p5beta1 - cloudbuild_v1 - cloudbuild_v1alpha1 - cloudbuild_v1alpha2 - clouderrorreporting_v1beta1 - cloudidentity_v1 - cloudidentity_v1beta1 - cloudiot_v1 - cloudresourcemanager_v1 - cloudresourcemanager_v1beta1 - cloudresourcemanager_v2 - cloudresourcemanager_v2beta1 - cloudsearch_v1 - cloudtasks_v2beta3 - container_v1 - container_v1beta1 - containeranalysis_v1alpha1 - containeranalysis_v1beta1 - content_v2 - content_v2_1 - datacatalog_v1beta1 - datafusion_v1 - datafusion_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - digitalassetlinks_v1 - displayvideo_v1 - dlp_v2 - documentai_v1beta2 - doubleclickbidmanager_v1 - doubleclickbidmanager_v1_1 - firebase_v1beta1 - firebasedynamiclinks_v1 - firebasehosting_v1beta1 - firebaseml_v1beta2 - firestore_v1 - firestore_v1beta1 - fitness_v1 - games_v1 - gameservices_v1 - gameservices_v1beta - healthcare_v1 - healthcare_v1beta1 - homegraph_v1 - iam_v1 - iap_v1 - iap_v1beta1 - jobs_v2 - jobs_v3 - jobs_v3p1beta1 - managedidentities_v1alpha1 - managedidentities_v1beta1 - ml_v1 - monitoring_v1 - osconfig_v1 - osconfig_v1beta - playcustomapp_v1 - prod_tt_sasportal_v1alpha1 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - runtimeconfig_v1beta1 - safebrowsing_v4 - secretmanager_v1 - secretmanager_v1beta1 - servicedirectory_v1beta1 - servicenetworking_v1 - speech_v1p1beta1 - sql_v1beta4 - storage_v1 - storagetransfer_v1 - texttospeech_v1beta1 - tpu_v1 - tpu_v1alpha1 - vault_v1 - verifiedaccess_v1 - videointelligence_v1 - videointelligence_v1beta2 - videointelligence_v1p1beta1 - videointelligence_v1p2beta1 - videointelligence_v1p3beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1 - youtube_partner_v1 - youtube_v3
2020-09-14 23:21:28 +00:00
# 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.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id``, where device_id is the unique
# ID assigned to the Device, and device_user_id is the unique ID assigned to the
# User.
# @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest] google_apps_cloudidentity_devices_v1_cancel_wipe_device_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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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 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
# Creates a device. Only company-owned device may be created.
# @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device] google_apps_cloudidentity_devices_v1_device_object
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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_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
# Deletes the specified device.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id``, where device_id is the unique
# ID assigned to the Device.
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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 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
# Retrieves the specified device.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in the format: `devices/`device_id``, where device_id is the
# unique ID assigned to the Device.
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Customer in the format: `customers/`customer_id``, where customer_id 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_id``, where customer_id is the
# customer to whom the device belongs.
# @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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device]
#
# @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 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
# Lists/Searches devices.
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer in the format: `customers/`customer_id``, where customer_id 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_id``, where customer_id is the
# customer to whom the device belongs.
# @param [String] filter
# Optional. Additional restrictions when fetching list of devices. [Help Center
# article link](https://support.google.com/a/answer/7549103)
# @param [String] order_by
# 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.
# @param [Fixnum] page_size
# 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.
# @param [String] page_token
# 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.
# @param [String] view
# Optional. The view to use for the List request.
# @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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDevicesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDevicesResponse]
#
# @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_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
# Wipes all data on the specified device.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1WipeDeviceRequest] google_apps_cloudidentity_devices_v1_wipe_device_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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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 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
# Approves device to access user data.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest] google_apps_cloudidentity_devices_v1_approve_device_user_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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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 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
# Blocks device from accessing user data
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest] google_apps_cloudidentity_devices_v1_block_device_user_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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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 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
# 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.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest] google_apps_cloudidentity_devices_v1_cancel_wipe_device_user_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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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 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
# Deletes the specified DeviceUser. This also revokes the user's access to
# device data.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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 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
# Retrieves the specified DeviceUser
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1DeviceUser] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1DeviceUser]
#
# @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 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
# Lists/Searches DeviceUsers.
# @param [String] parent
# 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`
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @param [String] filter
# Optional. Additional restrictions when fetching list of devices. [HC article](
# https://support.google.com/a/answer/7549103)
# @param [String] order_by
# Optional. Order specification for devices in the response.
# @param [Fixnum] page_size
# 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.
# @param [String] page_token
# 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.
# @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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse]
#
# @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_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
# 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.
# @param [String] parent
# Must be set to "devices/-/deviceUsers" to search across all DeviceUser
# belonging to the user.
# @param [String] android_id
# Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.
# com/reference/android/provider/Settings.Secure.html#ANDROID_ID).
# @param [Fixnum] page_size
# 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.
# @param [String] page_token
# 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.
# @param [String] raw_resource_id
# Raw Resource Id used by Google Endpoint Verification. If the user is enrolled
# into Google Endpoint Verification, this id will be saved as the '
# device_resource_id' field in the following platform dependent files. Mac: ~/.
# secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.
# secureConnect\context_aware_config.json Linux: ~/.secureConnect/
# context_aware_config.json
# @param [String] user_id
# 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.
# @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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse]
#
# @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 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
# 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.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest] google_apps_cloudidentity_devices_v1_wipe_device_user_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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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 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
# Gets the client state for the device user
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the ClientState in format: `devices/`device_id`/deviceUsers/`device_user_id`
# /clientStates/`partner_id``, where device_id is the unique ID assigned to the
# Device, device_user_id is the unique ID assigned to the User and partner_id
feat: Automated regeneration of cloudidentity v1 client (#1472) This PR was generated using Autosynth. :rainbow: <details><summary>Log from Synthtool</summary> ``` 2020-11-11 01:54:24,769 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py. On branch autosynth-cloudidentity-v1 nothing to commit, working tree clean 2020-11-11 01:54:24,798 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth cloudidentity v1 DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth cloudidentity v1 bundle install Don't run Bundler as root. Bundler can ask for sudo if it is needed, and installing your bundle as root will break this application for all non-root users on this machine. The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`. Fetching gem metadata from https://rubygems.org/......... Fetching gem metadata from https://rubygems.org/. Resolving dependencies... Fetching rake 11.3.0 Installing rake 11.3.0 Fetching concurrent-ruby 1.1.7 Installing concurrent-ruby 1.1.7 Fetching i18n 1.8.5 Installing i18n 1.8.5 Fetching minitest 5.14.2 Installing minitest 5.14.2 Fetching thread_safe 0.3.6 Installing thread_safe 0.3.6 Fetching tzinfo 1.2.8 Installing tzinfo 1.2.8 Fetching activesupport 5.0.7.2 Installing activesupport 5.0.7.2 Fetching public_suffix 4.0.6 Installing public_suffix 4.0.6 Fetching addressable 2.7.0 Installing addressable 2.7.0 Fetching ast 2.4.1 Installing ast 2.4.1 Using bundler 2.1.4 Fetching byebug 11.1.3 Installing byebug 11.1.3 with native extensions Fetching coderay 1.1.3 Installing coderay 1.1.3 Fetching json 2.3.1 Installing json 2.3.1 with native extensions Fetching docile 1.3.2 Installing docile 1.3.2 Fetching simplecov-html 0.10.2 Installing simplecov-html 0.10.2 Fetching simplecov 0.16.1 Installing simplecov 0.16.1 Using sync 0.5.0 Fetching tins 1.26.0 Installing tins 1.26.0 Fetching term-ansicolor 1.7.1 Installing term-ansicolor 1.7.1 Fetching thor 0.20.3 Installing thor 0.20.3 Fetching coveralls 0.8.23 Installing coveralls 0.8.23 Fetching crack 0.4.4 Installing crack 0.4.4 Fetching declarative 0.0.20 Installing declarative 0.0.20 Fetching declarative-option 0.1.0 Installing declarative-option 0.1.0 Fetching diff-lcs 1.4.4 Installing diff-lcs 1.4.4 Fetching dotenv 2.7.6 Installing dotenv 2.7.6 Fetching fakefs 0.20.1 Installing fakefs 0.20.1 Fetching multipart-post 2.1.1 Installing multipart-post 2.1.1 Fetching ruby2_keywords 0.0.2 Installing ruby2_keywords 0.0.2 Fetching faraday 1.1.0 Installing faraday 1.1.0 Fetching gems 1.2.0 Installing gems 1.2.0 Fetching github-markup 1.7.0 Installing github-markup 1.7.0 Fetching jwt 2.2.2 Installing jwt 2.2.2 Fetching memoist 0.16.2 Installing memoist 0.16.2 Fetching multi_json 1.15.0 Installing multi_json 1.15.0 Fetching os 0.9.6 Installing os 0.9.6 Fetching signet 0.14.0 Installing signet 0.14.0 Fetching googleauth 0.14.0 Installing googleauth 0.14.0 Fetching httpclient 2.8.3 Installing httpclient 2.8.3 Fetching mini_mime 1.0.2 Installing mini_mime 1.0.2 Fetching uber 0.1.0 Installing uber 0.1.0 Fetching representable 3.0.4 Installing representable 3.0.4 Fetching retriable 3.1.2 Installing retriable 3.1.2 Fetching rexml 3.2.4 Installing rexml 3.2.4 Using google-api-client 0.49.0 from source at `.` Fetching google-id-token 1.4.2 Installing google-id-token 1.4.2 Fetching hashdiff 1.0.1 Installing hashdiff 1.0.1 Fetching mime-types-data 3.2020.1104 Installing mime-types-data 3.2020.1104 Fetching mime-types 3.3.1 Installing mime-types 3.3.1 Fetching multi_xml 0.6.0 Installing multi_xml 0.6.0 Fetching httparty 0.18.1 Installing httparty 0.18.1 Fetching rspec-support 3.10.0 Installing rspec-support 3.10.0 Fetching rspec-core 3.10.0 Installing rspec-core 3.10.0 Fetching rspec-expectations 3.10.0 Installing rspec-expectations 3.10.0 Fetching rspec-mocks 3.10.0 Installing rspec-mocks 3.10.0 Fetching rspec 3.10.0 Installing rspec 3.10.0 Fetching json_spec 1.1.5 Installing json_spec 1.1.5 Fetching launchy 2.5.0 Installing launchy 2.5.0 Fetching little-plugger 1.1.4 Installing little-plugger 1.1.4 Fetching logging 2.3.0 Installing logging 2.3.0 Fetching method_source 1.0.0 Installing method_source 1.0.0 Fetching opencensus 0.5.0 Installing opencensus 0.5.0 Fetching parallel 1.20.0 Installing parallel 1.20.0 Fetching parser 2.7.2.0 Installing parser 2.7.2.0 Fetching powerpack 0.1.2 Installing powerpack 0.1.2 Fetching pry 0.13.1 Installing pry 0.13.1 Fetching pry-byebug 3.9.0 Installing pry-byebug 3.9.0 Fetching yard 0.9.25 Installing yard 0.9.25 Fetching pry-doc 0.13.5 Installing pry-doc 0.13.5 Fetching rainbow 2.2.2 Installing rainbow 2.2.2 with native extensions Fetching redcarpet 3.5.0 Installing redcarpet 3.5.0 with native extensions Fetching redis 3.3.5 Installing redis 3.3.5 Fetching rmail 1.1.4 Installing rmail 1.1.4 Fetching ruby-progressbar 1.10.1 Installing ruby-progressbar 1.10.1 Fetching unicode-display_width 1.7.0 Installing unicode-display_width 1.7.0 Fetching rubocop 0.49.1 Installing rubocop 0.49.1 Fetching webmock 2.3.2 Installing webmock 2.3.2 Bundle complete! 31 Gemfile dependencies, 78 gems now installed. Use `bundle info [gemname]` to see where a bundled gem is installed. Post-install message from i18n: HEADS UP! i18n 1.1 changed fallbacks to exclude default locale. But that may break your application. If you are upgrading your Rails application from an older version of Rails: Please check your Rails app for 'config.i18n.fallbacks = true'. If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be 'config.i18n.fallbacks = [I18n.default_locale]'. If not, fallbacks will be broken in your app by I18n 1.1.x. If you are starting a NEW Rails application, you can ignore this notice. For more info see: https://github.com/svenfuchs/i18n/releases/tag/v1.1.0 Post-install message from httparty: When you HTTParty, you must party hard! echo a | bundle exec bin/generate-api gen generated --api=cloudidentity.v1 --names-out=/workspace/api_names_out.yaml Loading cloudidentity, version v1 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/cloudidentity.v1.json conflict google/apis/cloudidentity_v1.rb <loudidentity_v1.rb? (enter "h" for help) [Ynaqdhm] a force google/apis/cloudidentity_v1.rb conflict google/apis/cloudidentity_v1/service.rb force google/apis/cloudidentity_v1/service.rb identical google/apis/cloudidentity_v1/classes.rb identical google/apis/cloudidentity_v1/representations.rb identical /workspace/api_names_out.yaml 2020-11-11 01:54:49,802 synthtool [DEBUG] > Wrote metadata to generated/google/apis/cloudidentity_v1/synth.metadata. DEBUG:synthtool:Wrote metadata to generated/google/apis/cloudidentity_v1/synth.metadata. ``` </details> Full log will be available here: https://source.cloud.google.com/results/invocations/563cc11f-8781-4ca7-969f-979083ad200c/targets - [ ] To automatically regenerate this PR, check this box.
2020-11-11 10:08:05 +00:00
# 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.
Autogenerated update (2020-09-14) Update: - accessapproval_v1 - accesscontextmanager_v1 - accesscontextmanager_v1beta - admin_directory_v1 - admob_v1 - analyticsreporting_v4 - androidpublisher_v3 - appengine_v1 - appengine_v1beta - bigquery_v2 - bigtableadmin_v1 - bigtableadmin_v2 - binaryauthorization_v1 - binaryauthorization_v1beta1 - calendar_v3 - civicinfo_v2 - cloudasset_v1 - cloudasset_v1beta1 - cloudasset_v1p5beta1 - cloudbuild_v1 - cloudbuild_v1alpha1 - cloudbuild_v1alpha2 - clouderrorreporting_v1beta1 - cloudidentity_v1 - cloudidentity_v1beta1 - cloudiot_v1 - cloudresourcemanager_v1 - cloudresourcemanager_v1beta1 - cloudresourcemanager_v2 - cloudresourcemanager_v2beta1 - cloudsearch_v1 - cloudtasks_v2beta3 - container_v1 - container_v1beta1 - containeranalysis_v1alpha1 - containeranalysis_v1beta1 - content_v2 - content_v2_1 - datacatalog_v1beta1 - datafusion_v1 - datafusion_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - digitalassetlinks_v1 - displayvideo_v1 - dlp_v2 - documentai_v1beta2 - doubleclickbidmanager_v1 - doubleclickbidmanager_v1_1 - firebase_v1beta1 - firebasedynamiclinks_v1 - firebasehosting_v1beta1 - firebaseml_v1beta2 - firestore_v1 - firestore_v1beta1 - fitness_v1 - games_v1 - gameservices_v1 - gameservices_v1beta - healthcare_v1 - healthcare_v1beta1 - homegraph_v1 - iam_v1 - iap_v1 - iap_v1beta1 - jobs_v2 - jobs_v3 - jobs_v3p1beta1 - managedidentities_v1alpha1 - managedidentities_v1beta1 - ml_v1 - monitoring_v1 - osconfig_v1 - osconfig_v1beta - playcustomapp_v1 - prod_tt_sasportal_v1alpha1 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - runtimeconfig_v1beta1 - safebrowsing_v4 - secretmanager_v1 - secretmanager_v1beta1 - servicedirectory_v1beta1 - servicenetworking_v1 - speech_v1p1beta1 - sql_v1beta4 - storage_v1 - storagetransfer_v1 - texttospeech_v1beta1 - tpu_v1 - tpu_v1alpha1 - vault_v1 - verifiedaccess_v1 - videointelligence_v1 - videointelligence_v1beta2 - videointelligence_v1p1beta1 - videointelligence_v1p2beta1 - videointelligence_v1p3beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1 - youtube_partner_v1 - youtube_v3
2020-09-14 23:21:28 +00:00
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState]
#
# @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 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
# Lists the client states for the given search query.
# @param [String] parent
# 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`
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @param [String] filter
# Optional. Additional restrictions when fetching list of client states.
# @param [String] order_by
# Optional. Order specification for client states in the response.
# @param [String] page_token
# 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.
# @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::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListClientStatesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListClientStatesResponse]
#
# @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_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
# Updates the client state for the device user
# @param [String] name
# Output only. [Resource name](https://cloud.google.com/apis/design/
# resource_names) of the ClientState in format: `devices/`device_id`/deviceUsers/
# `device_user_id`/clientState/`partner_id``, where partner_id corresponds to
# the partner storing the data. 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_id`-suffix`, where `
# customer_id` 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')
# @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState] google_apps_cloudidentity_devices_v1_client_state_object
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @param [String] update_mask
# Optional. Comma-separated list of fully qualified names of fields to be
# updated. If not specified, all updatable fields in ClientState are updated.
# @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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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 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
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# Creates a Group.
# @param [Google::Apis::CloudidentityV1::Group] group_object
Autogenerated update (2020-09-16) Update: - apigee_v1 - cloudidentity_v1 - container_v1beta1 - dialogflow_v3beta1 - firebasehosting_v1beta1 - iam_v1 - licensing_v1 - reseller_v1 - tasks_v1 - testing_v1
2020-09-16 00:39:02 +00:00
# @param [String] initial_group_config
# Optional. The initial configuration option for the `Group`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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
Autogenerated update (2020-09-16) Update: - apigee_v1 - cloudidentity_v1 - container_v1beta1 - dialogflow_v3beta1 - firebasehosting_v1beta1 - iam_v1 - licensing_v1 - reseller_v1 - tasks_v1 - testing_v1
2020-09-16 00:39:02 +00:00
def create_group(group_object = nil, initial_group_config: nil, fields: nil, quota_user: nil, options: nil, &block)
Autogenerated update (2019-05-10) Update: - cloudsearch_v1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2beta1 - logging_v2 - monitoring_v3 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vision_v1 - vision_v1p1beta1
2019-05-10 00:37:26 +00:00
command = make_simple_command(:post, 'v1/groups', options)
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
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
Autogenerated update (2020-09-16) Update: - apigee_v1 - cloudidentity_v1 - container_v1beta1 - dialogflow_v3beta1 - firebasehosting_v1beta1 - iam_v1 - licensing_v1 - reseller_v1 - tasks_v1 - testing_v1
2020-09-16 00:39:02 +00:00
command.query['initialGroupConfig'] = initial_group_config unless initial_group_config.nil?
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Deletes a `Group`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] name
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# 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``.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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 delete_group(name, fields: nil, quota_user: nil, options: nil, &block)
Autogenerated update (2019-05-10) Update: - cloudsearch_v1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2beta1 - logging_v2 - monitoring_v3 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vision_v1 - vision_v1p1beta1
2019-05-10 00:37:26 +00:00
command = make_simple_command(:delete, 'v1/{+name}', options)
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
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
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Retrieves a `Group`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] name
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# 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``.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @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::CloudidentityV1::Group] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Group]
#
# @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 get_group(name, fields: nil, quota_user: nil, options: nil, &block)
Autogenerated update (2019-05-10) Update: - cloudsearch_v1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2beta1 - logging_v2 - monitoring_v3 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vision_v1 - vision_v1p1beta1
2019-05-10 00:37:26 +00:00
command = make_simple_command(:get, 'v1/{+name}', options)
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
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
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Lists the `Group`s under a customer or namespace.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [Fixnum] page_size
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# 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`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] page_token
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# The `next_page_token` value returned from a previous list request, if any.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] parent
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# 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.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] view
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @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::CloudidentityV1::ListGroupsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::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)
Autogenerated update (2019-05-10) Update: - cloudsearch_v1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2beta1 - logging_v2 - monitoring_v3 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vision_v1 - vision_v1p1beta1
2019-05-10 00:37:26 +00:00
command = make_simple_command(:get, 'v1/groups', options)
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
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
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Looks up the [resource name](https://cloud.google.com/apis/design/
# resource_names) of a `Group` by its `EntityKey`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] group_key_id
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# The ID of the entity. For Google-managed entities, the `id` should 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`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] group_key_namespace
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# The namespace in which the entity exists. If not specified, the `EntityKey`
# represents a Google-managed entity such as a Google user or a Google Group. If
# specified, the `EntityKey` represents an external-identity-mapped group. The
# namespace must correspond to an identity source created in Admin Console and
# must be in the form of `identitysources/`identity_source_id`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @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::CloudidentityV1::LookupGroupNameResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::LookupGroupNameResponse]
#
# @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 lookup_group(group_key_id: nil, group_key_namespace: nil, fields: nil, quota_user: nil, options: nil, &block)
Autogenerated update (2019-05-10) Update: - cloudsearch_v1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2beta1 - logging_v2 - monitoring_v3 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vision_v1 - vision_v1p1beta1
2019-05-10 00:37:26 +00:00
command = make_simple_command(:get, 'v1/groups:lookup', options)
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
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
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Updates a `Group`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] name
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Output only. The [resource name](https://cloud.google.com/apis/design/
# resource_names) of the `Group`. Shall be of the form `groups/`group_id``.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [Google::Apis::CloudidentityV1::Group] group_object
# @param [String] update_mask
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Required. The fully-qualified names of fields to update. May only contain the
# following fields: `display_name`, `description`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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 patch_group(name, group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
Autogenerated update (2019-05-10) Update: - cloudsearch_v1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2beta1 - logging_v2 - monitoring_v3 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vision_v1 - vision_v1p1beta1
2019-05-10 00:37:26 +00:00
command = make_simple_command(:patch, 'v1/{+name}', options)
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
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
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Searches for `Group`s matching a specified query.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [Fixnum] page_size
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# 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`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] page_token
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# The `next_page_token` value returned from a previous search request, if any.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] query
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# 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`).
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] view
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @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::CloudidentityV1::SearchGroupsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::SearchGroupsResponse]
#
# @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 search_groups(page_size: nil, page_token: nil, query: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
Autogenerated update (2019-05-10) Update: - cloudsearch_v1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2beta1 - logging_v2 - monitoring_v3 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vision_v1 - vision_v1p1beta1
2019-05-10 00:37:26 +00:00
command = make_simple_command(:get, 'v1/groups:search', options)
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
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
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Creates a `Membership`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] parent
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Required. The parent `Group` resource under which to create the `Membership`.
# Must be of the form `groups/`group_id``.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [Google::Apis::CloudidentityV1::Membership] membership_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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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_membership(parent, membership_object = nil, fields: nil, quota_user: nil, options: nil, &block)
Autogenerated update (2019-05-10) Update: - cloudsearch_v1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2beta1 - logging_v2 - monitoring_v3 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vision_v1 - vision_v1p1beta1
2019-05-10 00:37:26 +00:00
command = make_simple_command(:post, 'v1/{+parent}/memberships', options)
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
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
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Deletes a `Membership`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] name
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# 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``
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @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::CloudidentityV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Operation]
#
# @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 delete_group_membership(name, fields: nil, quota_user: nil, options: nil, &block)
Autogenerated update (2019-05-10) Update: - cloudsearch_v1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2beta1 - logging_v2 - monitoring_v3 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vision_v1 - vision_v1p1beta1
2019-05-10 00:37:26 +00:00
command = make_simple_command(:delete, 'v1/{+name}', options)
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
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
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Retrieves a `Membership`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] name
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# 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``.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @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::CloudidentityV1::Membership] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::Membership]
#
# @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 get_group_membership(name, fields: nil, quota_user: nil, options: nil, &block)
Autogenerated update (2019-05-10) Update: - cloudsearch_v1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2beta1 - logging_v2 - monitoring_v3 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vision_v1 - vision_v1p1beta1
2019-05-10 00:37:26 +00:00
command = make_simple_command(:get, 'v1/{+name}', options)
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
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
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Lists the `Membership`s within a `Group`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] parent
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Required. The parent `Group` resource under which to lookup the `Membership`
# name. Must be of the form `groups/`group_id``.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [Fixnum] page_size
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# 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`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] page_token
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# The `next_page_token` value returned from a previous search request, if any.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] view
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @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::CloudidentityV1::ListMembershipsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::ListMembershipsResponse]
#
# @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_group_memberships(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
Autogenerated update (2019-05-10) Update: - cloudsearch_v1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2beta1 - logging_v2 - monitoring_v3 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vision_v1 - vision_v1p1beta1
2019-05-10 00:37:26 +00:00
command = make_simple_command(:get, 'v1/{+parent}/memberships', options)
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
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
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Looks up the [resource name](https://cloud.google.com/apis/design/
# resource_names) of a `Membership` by its `EntityKey`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] parent
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# Required. The parent `Group` resource under which to lookup the `Membership`
# name. Must be of the form `groups/`group_id``.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] member_key_id
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# The ID of the entity. For Google-managed entities, the `id` should 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`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @param [String] member_key_namespace
Autogenerated update (2020-09-30) Delete: - apigateway_v1alpha1 - apigateway_v1alpha2 - appsactivity_v1 Update: - books_v1 - cloudidentity_v1 - cloudidentity_v1beta1 - composer_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - memcache_v1beta2 - recommender_v1 - recommender_v1beta1 - youtube_partner_v1
2020-09-30 00:38:45 +00:00
# The namespace in which the entity exists. If not specified, the `EntityKey`
# represents a Google-managed entity such as a Google user or a Google Group. If
# specified, the `EntityKey` represents an external-identity-mapped group. The
# namespace must correspond to an identity source created in Admin Console and
# must be in the form of `identitysources/`identity_source_id`.
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
# @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::CloudidentityV1::LookupMembershipNameResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::LookupMembershipNameResponse]
#
# @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 lookup_group_membership(parent, member_key_id: nil, member_key_namespace: nil, fields: nil, quota_user: nil, options: nil, &block)
Autogenerated update (2019-05-10) Update: - cloudsearch_v1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2beta1 - logging_v2 - monitoring_v3 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vision_v1 - vision_v1p1beta1
2019-05-10 00:37:26 +00:00
command = make_simple_command(:get, 'v1/{+parent}/memberships:lookup', options)
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
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
Autogenerated update (2020-09-19) Update: - cloudidentity_v1 - cloudtasks_v2beta3 - customsearch_v1 - monitoring_v1 - monitoring_v3 - pubsub_v1 - redis_v1 - youtube_partner_v1
2020-09-19 00:39:29 +00:00
# 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::CloudidentityV1::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::CloudidentityV1::ModifyMembershipRolesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1::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, '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
Autogenerated update (2018-12-21) Update: - drive_v3 - logging_v2 - logging_v2beta1 - youtube_partner_v1
2018-12-21 00:36:47 +00:00
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end