2021-01-01 03:01:13 +00:00
|
|
|
# Copyright 2020 Google LLC
|
|
|
|
|
#
|
|
|
|
|
# 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 CloudidentityV1beta1
|
|
|
|
|
# Cloud Identity API
|
|
|
|
|
#
|
|
|
|
|
# API for provisioning and managing identity resources.
|
|
|
|
|
#
|
|
|
|
|
# @example
|
|
|
|
|
# require 'google/apis/cloudidentity_v1beta1'
|
|
|
|
|
#
|
|
|
|
|
# Cloudidentity = Google::Apis::CloudidentityV1beta1 # 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
|
2021-01-01 17:40:59 +00:00
|
|
|
super('https://cloudidentity.googleapis.com/', '',
|
|
|
|
|
client_name: 'google-apis-cloudidentity_v1beta1',
|
|
|
|
|
client_version: Google::Apis::CloudidentityV1beta1::GEM_VERSION)
|
2021-01-01 03:01:13 +00:00
|
|
|
@batch_path = 'batch'
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
|
# @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 [Google::Apis::CloudidentityV1beta1::CancelWipeDeviceRequest] 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::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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_wipe_device(name, cancel_wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1beta1/{+name}:cancelWipe', options)
|
|
|
|
|
command.request_representation = Google::Apis::CloudidentityV1beta1::CancelWipeDeviceRequest::Representation
|
|
|
|
|
command.request_object = cancel_wipe_device_request_object
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['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. **Note**: This
|
|
|
|
|
# method is available only to customers who have one of the following SKUs:
|
|
|
|
|
# Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud
|
|
|
|
|
# Identity Premium
|
|
|
|
|
# @param [Google::Apis::CloudidentityV1beta1::CreateDeviceRequest] create_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::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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(create_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1beta1/devices', options)
|
|
|
|
|
command.request_representation = Google::Apis::CloudidentityV1beta1::CreateDeviceRequest::Representation
|
|
|
|
|
command.request_object = create_device_request_object
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# 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::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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, 'v1beta1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['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 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 format: `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::CloudidentityV1beta1::Device] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::Device]
|
|
|
|
|
#
|
|
|
|
|
# @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, 'v1beta1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Device::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Device
|
|
|
|
|
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.
|
|
|
|
|
# @param [String] filter
|
|
|
|
|
# Optional. Additional restrictions when fetching list of devices. For a list of
|
|
|
|
|
# search fields, refer to [Mobile device search fields](https://developers.
|
|
|
|
|
# google.com/admin-sdk/directory/v1/search-operators). Multiple search fields
|
|
|
|
|
# are separated by the space character.
|
|
|
|
|
# @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 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::CloudidentityV1beta1::ListDevicesResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::ListDevicesResponse]
|
|
|
|
|
#
|
|
|
|
|
# @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, 'v1beta1/devices', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::ListDevicesResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::ListDevicesResponse
|
|
|
|
|
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::CloudidentityV1beta1::WipeDeviceRequest] 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::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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, wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1beta1/{+name}:wipe', options)
|
|
|
|
|
command.request_representation = Google::Apis::CloudidentityV1beta1::WipeDeviceRequest::Representation
|
|
|
|
|
command.request_object = wipe_device_request_object
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['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::CloudidentityV1beta1::ApproveDeviceUserRequest] 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::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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_user(name, approve_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1beta1/{+name}:approve', options)
|
|
|
|
|
command.request_representation = Google::Apis::CloudidentityV1beta1::ApproveDeviceUserRequest::Representation
|
|
|
|
|
command.request_object = approve_device_user_request_object
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['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::CloudidentityV1beta1::BlockDeviceUserRequest] 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::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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_user(name, block_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1beta1/{+name}:block', options)
|
|
|
|
|
command.request_representation = Google::Apis::CloudidentityV1beta1::BlockDeviceUserRequest::Representation
|
|
|
|
|
command.request_object = block_device_user_request_object
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['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::CloudidentityV1beta1::CancelWipeDeviceUserRequest] 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::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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_wipe_device_user(name, cancel_wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1beta1/{+name}:cancelWipe', options)
|
|
|
|
|
command.request_representation = Google::Apis::CloudidentityV1beta1::CancelWipeDeviceUserRequest::Representation
|
|
|
|
|
command.request_object = cancel_wipe_device_user_request_object
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['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::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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, 'v1beta1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['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::CloudidentityV1beta1::DeviceUser] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::DeviceUser]
|
|
|
|
|
#
|
|
|
|
|
# @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, 'v1beta1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::DeviceUser::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::DeviceUser
|
|
|
|
|
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. For a list of
|
|
|
|
|
# search fields, refer to [Mobile device search fields](https://developers.
|
|
|
|
|
# google.com/admin-sdk/directory/v1/search-operators). Multiple search fields
|
|
|
|
|
# are separated by the space character.
|
|
|
|
|
# @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::CloudidentityV1beta1::ListDeviceUsersResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse]
|
|
|
|
|
#
|
|
|
|
|
# @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, 'v1beta1/{+parent}/deviceUsers', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse
|
|
|
|
|
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::CloudidentityV1beta1::LookupSelfDeviceUsersResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse]
|
|
|
|
|
#
|
|
|
|
|
# @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, 'v1beta1/{+parent}:lookup', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse
|
|
|
|
|
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.
|
|
|
|
|
# @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::CloudidentityV1beta1::WipeDeviceUserRequest] 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::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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_user(name, wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1beta1/{+name}:wipe', options)
|
|
|
|
|
command.request_representation = Google::Apis::CloudidentityV1beta1::WipeDeviceUserRequest::Representation
|
|
|
|
|
command.request_object = wipe_device_user_request_object
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['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
|
|
|
|
|
# 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.
|
|
|
|
|
# @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::CloudidentityV1beta1::ClientState] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::ClientState]
|
|
|
|
|
#
|
|
|
|
|
# @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, 'v1beta1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::ClientState::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::ClientState
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
# Updates the client state for the device user **Note**: This method is
|
|
|
|
|
# available only to customers who have one of the following SKUs: Enterprise
|
|
|
|
|
# Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity
|
|
|
|
|
# Premium
|
|
|
|
|
# @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.
|
|
|
|
|
# @param [Google::Apis::CloudidentityV1beta1::ClientState] 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::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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, client_state_object = nil, customer: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
|
|
|
|
command.request_representation = Google::Apis::CloudidentityV1beta1::ClientState::Representation
|
|
|
|
|
command.request_object = client_state_object
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['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
|
|
|
|
|
|
|
|
|
|
# Creates a `Group`.
|
|
|
|
|
# @param [Google::Apis::CloudidentityV1beta1::Group] group_object
|
|
|
|
|
# @param [String] initial_group_config
|
|
|
|
|
# Required. The initial configuration option for the `Group`.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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(group_object = nil, initial_group_config: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1beta1/groups', options)
|
|
|
|
|
command.request_representation = Google::Apis::CloudidentityV1beta1::Group::Representation
|
|
|
|
|
command.request_object = group_object
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.query['initialGroupConfig'] = initial_group_config unless initial_group_config.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Deletes a `Group`.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The [resource name](https://cloud.google.com/apis/design/
|
|
|
|
|
# resource_names) of the `Group` to retrieve. Must be of the form `groups/`
|
|
|
|
|
# group_id``.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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)
|
|
|
|
|
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Retrieves a `Group`.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The [resource name](https://cloud.google.com/apis/design/
|
|
|
|
|
# resource_names) of the `Group` to retrieve. Must be of the form `groups/`
|
|
|
|
|
# group_id``.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Group] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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)
|
|
|
|
|
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Group::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Group
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Lists the `Group`s under a customer or namespace.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# The maximum number of results to return. Note that the number of results
|
|
|
|
|
# returned may be less than this value even if there are more available results.
|
|
|
|
|
# To fetch all results, clients must continue calling this method repeatedly
|
|
|
|
|
# until the response no longer contains a `next_page_token`. If unspecified,
|
|
|
|
|
# defaults to 200 for `View.BASIC` and to 50 for `View.FULL`. Must not be
|
|
|
|
|
# greater than 1000 for `View.BASIC` or 500 for `View.FULL`.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# The `next_page_token` value returned from a previous list request, if any.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# Required. The parent resource under which to list all `Group`s. Must be of the
|
|
|
|
|
# form `identitysources/`identity_source_id`` for external- identity-mapped
|
|
|
|
|
# groups or `customers/`customer_id`` for Google Groups.
|
|
|
|
|
# @param [String] view
|
|
|
|
|
# The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::ListGroupsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::ListGroupsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_groups(page_size: nil, page_token: nil, parent: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1beta1/groups', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::ListGroupsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::ListGroupsResponse
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['view'] = view unless view.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Looks up the [resource name](https://cloud.google.com/apis/design/
|
|
|
|
|
# resource_names) of a `Group` by its `EntityKey`.
|
|
|
|
|
# @param [String] group_key_id
|
|
|
|
|
# The ID of the entity. For Google-managed entities, the `id` must be the email
|
|
|
|
|
# address of an existing group or user. For external-identity-mapped entities,
|
|
|
|
|
# the `id` must be a string conforming to the Identity Source's requirements.
|
|
|
|
|
# Must be unique within a `namespace`.
|
|
|
|
|
# @param [String] group_key_namespace
|
|
|
|
|
# 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`.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::LookupGroupNameResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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)
|
|
|
|
|
command = make_simple_command(:get, 'v1beta1/groups:lookup', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::LookupGroupNameResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::LookupGroupNameResponse
|
|
|
|
|
command.query['groupKey.id'] = group_key_id unless group_key_id.nil?
|
|
|
|
|
command.query['groupKey.namespace'] = group_key_namespace unless group_key_namespace.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Updates a `Group`.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Output only. The [resource name](https://cloud.google.com/apis/design/
|
|
|
|
|
# resource_names) of the `Group`. Shall be of the form `groups/`group_id``.
|
|
|
|
|
# @param [Google::Apis::CloudidentityV1beta1::Group] group_object
|
|
|
|
|
# @param [String] update_mask
|
|
|
|
|
# Required. The fully-qualified names of fields to update. May only contain the
|
|
|
|
|
# following fields: `display_name`, `description`.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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)
|
|
|
|
|
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
|
|
|
|
command.request_representation = Google::Apis::CloudidentityV1beta1::Group::Representation
|
|
|
|
|
command.request_object = group_object
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Searches for `Group`s matching a specified query.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# The maximum number of results to return. Note that the number of results
|
|
|
|
|
# returned may be less than this value even if there are more available results.
|
|
|
|
|
# To fetch all results, clients must continue calling this method repeatedly
|
|
|
|
|
# until the response no longer contains a `next_page_token`. If unspecified,
|
|
|
|
|
# defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not
|
|
|
|
|
# be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# The `next_page_token` value returned from a previous search request, if any.
|
|
|
|
|
# @param [String] query
|
|
|
|
|
# Required. The search query. Must be specified in [Common Expression Language](
|
|
|
|
|
# https://opensource.google/projects/cel). May only contain equality operators
|
|
|
|
|
# on the parent and inclusion operators on labels (e.g., `parent == 'customers/`
|
|
|
|
|
# customer_id`' && 'cloudidentity.googleapis.com/groups.discussion_forum' in
|
|
|
|
|
# labels`).
|
|
|
|
|
# @param [String] view
|
|
|
|
|
# The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::SearchGroupsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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)
|
|
|
|
|
command = make_simple_command(:get, 'v1beta1/groups:search', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::SearchGroupsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::SearchGroupsResponse
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['query'] = query unless query.nil?
|
|
|
|
|
command.query['view'] = view unless view.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Check a potential member for membership in a group. **Note:** This feature is
|
|
|
|
|
# only available to Google Workspace Enterprise Standard, Enterprise Plus, and
|
|
|
|
|
# Enterprise for Education; and Cloud Identity Premium accounts. A member has
|
|
|
|
|
# membership to a group as long as there is a single viewable transitive
|
|
|
|
|
# membership between the group and the member. The actor must have view
|
|
|
|
|
# permissions to at least one transitive membership between the member and group.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# [Resource name](https://cloud.google.com/apis/design/resource_names) of the
|
|
|
|
|
# group to check the transitive membership in. Format: `groups/`group_id``,
|
|
|
|
|
# where `group_id` is the unique id assigned to the Group to which the
|
|
|
|
|
# Membership belongs to.
|
|
|
|
|
# @param [String] query
|
|
|
|
|
# Required. A CEL expression that MUST include member specification. This is a `
|
|
|
|
|
# required` field. Certain groups are uniquely identified by both a '
|
|
|
|
|
# member_key_id' and a 'member_key_namespace', which requires an additional
|
|
|
|
|
# query input: 'member_key_namespace'. Example query: `member_key_id == '
|
|
|
|
|
# member_key_id_value'`
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::CheckTransitiveMembershipResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::CheckTransitiveMembershipResponse]
|
|
|
|
|
#
|
|
|
|
|
# @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 check_group_membership_transitive_membership(parent, query: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1beta1/{+parent}/memberships:checkTransitiveMembership', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::CheckTransitiveMembershipResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::CheckTransitiveMembershipResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['query'] = query unless query.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Creates a `Membership`.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# Required. The parent `Group` resource under which to create the `Membership`.
|
|
|
|
|
# Must be of the form `groups/`group_id``.
|
|
|
|
|
# @param [Google::Apis::CloudidentityV1beta1::Membership] membership_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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)
|
|
|
|
|
command = make_simple_command(:post, 'v1beta1/{+parent}/memberships', options)
|
|
|
|
|
command.request_representation = Google::Apis::CloudidentityV1beta1::Membership::Representation
|
|
|
|
|
command.request_object = membership_object
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Deletes a `Membership`.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The [resource name](https://cloud.google.com/apis/design/
|
|
|
|
|
# resource_names) of the `Membership` to delete. Must be of the form `groups/`
|
|
|
|
|
# group_id`/memberships/`membership_id``.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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)
|
|
|
|
|
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Retrieves a `Membership`.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The [resource name](https://cloud.google.com/apis/design/
|
|
|
|
|
# resource_names) of the `Membership` to retrieve. Must be of the form `groups/`
|
|
|
|
|
# group_id`/memberships/`membership_id``.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Membership] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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)
|
|
|
|
|
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Membership::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Membership
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Get a membership graph of just a member or both a member and a group. **Note:**
|
|
|
|
|
# This feature is only available to Google Workspace Enterprise Standard,
|
|
|
|
|
# Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium
|
|
|
|
|
# accounts. Given a member, the response will contain all membership paths from
|
|
|
|
|
# the member. Given both a group and a member, the response will contain all
|
|
|
|
|
# membership paths between the group and the member.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
|
|
|
|
|
# of the group to search transitive memberships in. Format: `groups/`group_id``,
|
|
|
|
|
# where `group_id` is the unique ID assigned to the Group to which the
|
|
|
|
|
# Membership belongs to. group_id can be a wildcard collection id "-". When a
|
|
|
|
|
# group_id is specified, the membership graph will be constrained to paths
|
|
|
|
|
# between the member (defined in the query) and the parent. If a wildcard
|
|
|
|
|
# collection is provided, all membership paths connected to the member will be
|
|
|
|
|
# returned.
|
|
|
|
|
# @param [String] query
|
|
|
|
|
# Required. A CEL expression that MUST include member specification AND label(s).
|
|
|
|
|
# Certain groups are uniquely identified by both a 'member_key_id' and a '
|
|
|
|
|
# member_key_namespace', which requires an additional query input: '
|
|
|
|
|
# member_key_namespace'. Example query: `member_key_id == 'member_key_id_value' &
|
|
|
|
|
# & in labels`
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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 get_group_membership_membership_graph(parent, query: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1beta1/{+parent}/memberships:getMembershipGraph', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['query'] = query unless query.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Lists the `Membership`s within a `Group`.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# Required. The parent `Group` resource under which to lookup the `Membership`
|
|
|
|
|
# name. Must be of the form `groups/`group_id``.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# The maximum number of results to return. Note that the number of results
|
|
|
|
|
# returned may be less than this value even if there are more available results.
|
|
|
|
|
# To fetch all results, clients must continue calling this method repeatedly
|
|
|
|
|
# until the response no longer contains a `next_page_token`. If unspecified,
|
|
|
|
|
# defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not
|
|
|
|
|
# be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# The `next_page_token` value returned from a previous search request, if any.
|
|
|
|
|
# @param [String] view
|
|
|
|
|
# The level of detail to be returned. If unspecified, defaults to `
|
|
|
|
|
# MembershipView.BASIC`.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::ListMembershipsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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)
|
|
|
|
|
command = make_simple_command(:get, 'v1beta1/{+parent}/memberships', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::ListMembershipsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::ListMembershipsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['view'] = view unless view.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Looks up the [resource name](https://cloud.google.com/apis/design/
|
|
|
|
|
# resource_names) of a `Membership` by its `EntityKey`.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# Required. The parent `Group` resource under which to lookup the `Membership`
|
|
|
|
|
# name. Must be of the form `groups/`group_id``.
|
|
|
|
|
# @param [String] member_key_id
|
|
|
|
|
# The ID of the entity. For Google-managed entities, the `id` must be the email
|
|
|
|
|
# address of an existing group or user. For external-identity-mapped entities,
|
|
|
|
|
# the `id` must be a string conforming to the Identity Source's requirements.
|
|
|
|
|
# Must be unique within a `namespace`.
|
|
|
|
|
# @param [String] member_key_namespace
|
|
|
|
|
# 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`.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::LookupMembershipNameResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::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)
|
|
|
|
|
command = make_simple_command(:get, 'v1beta1/{+parent}/memberships:lookup', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::LookupMembershipNameResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::LookupMembershipNameResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['memberKey.id'] = member_key_id unless member_key_id.nil?
|
|
|
|
|
command.query['memberKey.namespace'] = member_key_namespace unless member_key_namespace.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Modifies the `MembershipRole`s of a `Membership`.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The [resource name](https://cloud.google.com/apis/design/
|
|
|
|
|
# resource_names) of the `Membership` whose roles are to be modified. Must be of
|
|
|
|
|
# the form `groups/`group_id`/memberships/`membership_id``.
|
|
|
|
|
# @param [Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesRequest] modify_membership_roles_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def modify_membership_roles(name, modify_membership_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1beta1/{+name}:modifyMembershipRoles', options)
|
|
|
|
|
command.request_representation = Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesRequest::Representation
|
|
|
|
|
command.request_object = modify_membership_roles_request_object
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Search transitive groups of a member. **Note:** This feature is only available
|
|
|
|
|
# to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for
|
|
|
|
|
# Education; and Cloud Identity Premium accounts. A transitive group is any
|
|
|
|
|
# group that has a direct or indirect membership to the member. Actor must have
|
|
|
|
|
# view permissions all transitive groups.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# [Resource name](https://cloud.google.com/apis/design/resource_names) of the
|
|
|
|
|
# group to search transitive memberships in. Format: `groups/`group_id``, where `
|
|
|
|
|
# group_id` is always '-' as this API will search across all groups for a given
|
|
|
|
|
# member.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# The default page size is 200 (max 1000).
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# The next_page_token value returned from a previous list request, if any.
|
|
|
|
|
# @param [String] query
|
|
|
|
|
# Required. A CEL expression that MUST include member specification AND label(s).
|
|
|
|
|
# This is a `required` field. Users can search on label attributes of groups.
|
|
|
|
|
# CONTAINS match ('in') is supported on labels. Certain groups are uniquely
|
|
|
|
|
# identified by both a 'member_key_id' and a 'member_key_namespace', which
|
|
|
|
|
# requires an additional query input: 'member_key_namespace'. Example query: `
|
|
|
|
|
# member_key_id == 'member_key_id_value' && in labels`
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::SearchTransitiveGroupsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::SearchTransitiveGroupsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @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_group_membership_transitive_groups(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1beta1/{+parent}/memberships:searchTransitiveGroups', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::SearchTransitiveGroupsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::SearchTransitiveGroupsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['query'] = query unless query.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Search transitive memberships of a group. **Note:** This feature is only
|
|
|
|
|
# available to Google Workspace Enterprise Standard, Enterprise Plus, and
|
|
|
|
|
# Enterprise for Education; and Cloud Identity Premium accounts. A transitive
|
|
|
|
|
# membership is any direct or indirect membership of a group. Actor must have
|
|
|
|
|
# view permissions to all transitive memberships.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# [Resource name](https://cloud.google.com/apis/design/resource_names) of the
|
|
|
|
|
# group to search transitive memberships in. Format: `groups/`group_id``, where `
|
|
|
|
|
# group_id` is the unique ID assigned to the Group.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# The default page size is 200 (max 1000).
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# The next_page_token value returned from a previous list request, if any.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::CloudidentityV1beta1::SearchTransitiveMembershipsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::CloudidentityV1beta1::SearchTransitiveMembershipsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @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_group_membership_transitive_memberships(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1beta1/{+parent}/memberships:searchTransitiveMemberships', options)
|
|
|
|
|
command.response_representation = Google::Apis::CloudidentityV1beta1::SearchTransitiveMembershipsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::CloudidentityV1beta1::SearchTransitiveMembershipsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
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
|
