class Google::Apis::AdminDirectoryV1::DirectoryService

Admin SDK API

Admin SDK lets administrators of enterprise domains to view and manage

resources like user, groups etc. It also provides audit and usage reports of
domain.

@example

require 'google/apis/admin_directory_v1'

Admin = Google::Apis::AdminDirectoryV1 # Alias the module
service = Admin::DirectoryService.new

@see developers.google.com/admin-sdk/

Attributes

key[RW]

@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.
quota_user[RW]

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

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/admin_directory_v1/service.rb, line 47
def initialize
  super('https://admin.googleapis.com/', '',
        client_name: 'google-apis-admin_directory_v1',
        client_version: Google::Apis::AdminDirectoryV1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

action_chromeosdevice(customer_id, resource_id, chrome_os_device_action_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. Warning: * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center] (support.google.com/chrome/a/answer/3523633). @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [String] resource_id

The unique ID of the device. The `resourceId`s are returned in the response
from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/
chromeosdevices/list) method.

@param [Google::Apis::AdminDirectoryV1::ChromeOsDeviceAction] chrome_os_device_action_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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 215
def action_chromeosdevice(customer_id, resource_id, chrome_os_device_action_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::ChromeOsDeviceAction::Representation
  command.request_object = chrome_os_device_action_object
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['resourceId'] = resource_id unless resource_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
action_mobile_device(customer_id, resource_id, mobile_device_action_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Takes an action that affects a mobile device. For example, remotely wiping a device. @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [String] resource_id

The unique ID the API service uses to identify the mobile device.

@param [Google::Apis::AdminDirectoryV1::MobileDeviceAction] mobile_device_action_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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1779
def action_mobile_device(customer_id, resource_id, mobile_device_action_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::MobileDeviceAction::Representation
  command.request_object = mobile_device_action_object
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['resourceId'] = resource_id unless resource_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
batch_create_printers(parent, batch_create_printers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates printers under given Organization Unit. @param [String] parent

Required. The name of the customer. Format: customers/`customer_id`

@param [Google::Apis::AdminDirectoryV1::BatchCreatePrintersRequest] batch_create_printers_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::AdminDirectoryV1::BatchCreatePrintersResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::BatchCreatePrintersResponse]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 641
def batch_create_printers(parent, batch_create_printers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/{+parent}/chrome/printers:batchCreatePrinters', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::BatchCreatePrintersRequest::Representation
  command.request_object = batch_create_printers_request_object
  command.response_representation = Google::Apis::AdminDirectoryV1::BatchCreatePrintersResponse::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::BatchCreatePrintersResponse
  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
batch_delete_printers(parent, batch_delete_printers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes printers in batch. @param [String] parent

Required. The name of the customer. Format: customers/`customer_id`

@param [Google::Apis::AdminDirectoryV1::BatchDeletePrintersRequest] batch_delete_printers_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::AdminDirectoryV1::BatchDeletePrintersResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::BatchDeletePrintersResponse]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 674
def batch_delete_printers(parent, batch_delete_printers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/{+parent}/chrome/printers:batchDeletePrinters', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::BatchDeletePrintersRequest::Representation
  command.request_object = batch_delete_printers_request_object
  command.response_representation = Google::Apis::AdminDirectoryV1::BatchDeletePrintersResponse::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::BatchDeletePrintersResponse
  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
calendar_resource(customer, calendar_resource_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Inserts a calendar resource. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_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::AdminDirectoryV1::CalendarResource] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::CalendarResource]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2488
def calendar_resource(customer, calendar_resource_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/resources/calendars', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
  command.request_object = calendar_resource_object
  command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::CalendarResource
  command.params['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
create_customer_chrome_printer(parent, printer_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates a printer under given Organization Unit. @param [String] parent

Required. The name of the customer. Format: customers/`customer_id`

@param [Google::Apis::AdminDirectoryV1::Printer] printer_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::AdminDirectoryV1::Printer] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Printer]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 707
def create_customer_chrome_printer(parent, printer_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/{+parent}/chrome/printers', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Printer::Representation
  command.request_object = printer_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Printer::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Printer
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_asp(user_key, code_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes an ASP issued by a user. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [Fixnum] code_id

The unique ID of the ASP to be deleted.

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 77
def delete_asp(user_key, code_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/users/{userKey}/asps/{codeId}', options)
  command.params['userKey'] = user_key unless user_key.nil?
  command.params['codeId'] = code_id unless code_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
delete_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a calendar resource. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] calendar_resource_id

The unique ID of the calendar resource to delete.

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2421
def delete_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}', options)
  command.params['customer'] = customer unless customer.nil?
  command.params['calendarResourceId'] = calendar_resource_id unless calendar_resource_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
delete_customer_chrome_printer(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a `Printer`. @param [String] name

Required. The name of the printer to be updated. Format: customers/`
customer_id`/chrome/printers/`printer_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::AdminDirectoryV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Empty]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 740
def delete_customer_chrome_printer(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/{+name}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Empty::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_domain(customer, domain_name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a domain of the customer. @param [String] customer

Immutable ID of the Google Workspace account.

@param [String] domain_name

Name of domain to be deleted

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1067
def delete_domain(customer, domain_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/domains/{domainName}', options)
  command.params['customer'] = customer unless customer.nil?
  command.params['domainName'] = domain_name unless domain_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a domain Alias of the customer. @param [String] customer

Immutable ID of the Google Workspace account.

@param [String] domain_alias_name

Name of domain alias to be retrieved.

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 937
def delete_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}', options)
  command.params['customer'] = customer unless customer.nil?
  command.params['domainAliasName'] = domain_alias_name unless domain_alias_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_group(group_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a group. @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique 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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1193
def delete_group(group_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/groups/{groupKey}', options)
  command.params['groupKey'] = group_key unless group_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_group_alias(group_key, group_alias, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Removes an alias. @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique group ID.

@param [String] group_alias

The alias to be removed

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1414
def delete_group_alias(group_key, group_alias, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/groups/{groupKey}/aliases/{alias}', options)
  command.params['groupKey'] = group_key unless group_key.nil?
  command.params['alias'] = group_alias unless group_alias.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_member(group_key, member_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Removes a member from a group. @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique group ID.

@param [String] member_key

Identifies the group member in the API request. A group member can be a user
or another group. The value can be the member's (group or user) primary email
address, alias, or unique 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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1513
def delete_member(group_key, member_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/groups/{groupKey}/members/{memberKey}', options)
  command.params['groupKey'] = group_key unless group_key.nil?
  command.params['memberKey'] = member_key unless member_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_mobile_device(customer_id, resource_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Removes a mobile device. @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [String] resource_id

The unique ID the API service uses to identify the mobile device.

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1815
def delete_mobile_device(customer_id, resource_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}', options)
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['resourceId'] = resource_id unless resource_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
delete_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Removes an organizational unit. @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [String] org_unit_path

The full path of the organizational unit or its unique 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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1941
def delete_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/customer/{customerId}/orgunits/{+orgUnitPath}', options)
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['orgUnitPath'] = org_unit_path unless org_unit_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_resource_building(customer, building_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a building. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] building_id

The id of the building to delete.

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2195
def delete_resource_building(customer, building_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}', options)
  command.params['customer'] = customer unless customer.nil?
  command.params['buildingId'] = building_id unless building_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
delete_resource_feature(customer, feature_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a feature. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] feature_key

The unique ID of the feature to delete.

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2659
def delete_resource_feature(customer, feature_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/resources/features/{featureKey}', options)
  command.params['customer'] = customer unless customer.nil?
  command.params['featureKey'] = feature_key unless feature_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_role(customer, role_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a role. @param [String] customer

Immutable ID of the Google Workspace account.

@param [String] role_id

Immutable ID of the role.

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3051
def delete_role(customer, role_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/roles/{roleId}', options)
  command.params['customer'] = customer unless customer.nil?
  command.params['roleId'] = role_id unless role_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
delete_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a role assignment. @param [String] customer

Immutable ID of the Google Workspace account.

@param [String] role_assignment_id

Immutable ID of the role assignment.

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2910
def delete_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}', options)
  command.params['customer'] = customer unless customer.nil?
  command.params['roleAssignmentId'] = role_assignment_id unless role_assignment_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
delete_schema(customer_id, schema_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a schema. @param [String] customer_id

Immutable ID of the Google Workspace account.

@param [String] schema_key

Name or immutable ID of the schema.

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3256
def delete_schema(customer_id, schema_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/customer/{customerId}/schemas/{schemaKey}', options)
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['schemaKey'] = schema_key unless schema_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_token(user_key, client_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes all access tokens issued by a user for an application. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [String] client_id

The Client ID of the application the token is issued to.

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3456
def delete_token(user_key, client_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/users/{userKey}/tokens/{clientId}', options)
  command.params['userKey'] = user_key unless user_key.nil?
  command.params['clientId'] = client_id unless client_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
delete_user(user_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a user. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user 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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3580
def delete_user(user_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/users/{userKey}', options)
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_user_alias(user_key, user_alias, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Removes an alias. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [String] user_alias

The alias to be removed.

@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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3997
def delete_user_alias(user_key, user_alias, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/users/{userKey}/aliases/{alias}', options)
  command.params['userKey'] = user_key unless user_key.nil?
  command.params['alias'] = user_alias unless user_alias.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_user_photo(user_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Removes the user's photo. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user 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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 4131
def delete_user_photo(user_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'admin/directory/v1/users/{userKey}/photos/thumbnail', options)
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
generate_verification_code(user_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Generates new backup verification codes for the user. @param [String] user_key

Email or immutable ID of the 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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 4259
def generate_verification_code(user_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/verificationCodes/generate', options)
  command.params['userKey'] = user_key unless user_key.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_asp(user_key, code_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets information about an ASP issued by a user. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [Fixnum] code_id

The unique ID of the ASP.

@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::AdminDirectoryV1::Asp] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Asp]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 109
def get_asp(user_key, code_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/asps/{codeId}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Asp::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Asp
  command.params['userKey'] = user_key unless user_key.nil?
  command.params['codeId'] = code_id unless code_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
get_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a calendar resource. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] calendar_resource_id

The unique ID of the calendar resource to retrieve.

@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::AdminDirectoryV1::CalendarResource] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::CalendarResource]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2454
def get_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::CalendarResource
  command.params['customer'] = customer unless customer.nil?
  command.params['calendarResourceId'] = calendar_resource_id unless calendar_resource_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
get_chrome_os_device(customer_id, device_id, projection: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a Chrome OS device's properties. @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [String] device_id

The unique ID of the device. The `deviceId`s are returned in the response from
the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/
list) method.

@param [String] projection

Determines whether the response contains the full list of properties or only a
subset.

@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::AdminDirectoryV1::ChromeOsDevice] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::ChromeOsDevice]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 256
def get_chrome_os_device(customer_id, device_id, projection: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::ChromeOsDevice
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.query['projection'] = projection unless projection.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_customer(customer_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a customer. @param [String] customer_key

Id of the customer to be retrieved

@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::AdminDirectoryV1::Customer] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Customer]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 544
def get_customer(customer_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customers/{customerKey}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Customer::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Customer
  command.params['customerKey'] = customer_key unless customer_key.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_customer_chrome_printer(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Returns a `Printer` resource (printer's config). @param [String] name

Required. The name of the printer to retrieve. Format: customers/`customer_id`/
chrome/printers/`printer_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::AdminDirectoryV1::Printer] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Printer]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 771
def get_customer_chrome_printer(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/{+name}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Printer::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Printer
  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_customer_device_chromeo_command(customer_id, device_id, command_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets command data a specific command issued to the device. @param [String] customer_id

Immutable. Immutable ID of the Google Workspace account.

@param [String] device_id

Immutable. Immutable ID of Chrome OS Device.

@param [Fixnum] command_id

Immutable. Immutable ID of Chrome OS Device Command.

@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::AdminDirectoryV1::DirectoryChromeosdevicesCommand] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesCommand]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 512
def get_customer_device_chromeo_command(customer_id, device_id, command_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesCommand::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesCommand
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.params['commandId'] = command_id unless command_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
get_domain(customer, domain_name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a domain of the customer. @param [String] customer

Immutable ID of the Google Workspace account.

@param [String] domain_name

Name of domain to be retrieved

@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::AdminDirectoryV1::Domains] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Domains]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1098
def get_domain(customer, domain_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/domains/{domainName}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Domains::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Domains
  command.params['customer'] = customer unless customer.nil?
  command.params['domainName'] = domain_name unless domain_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_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a domain alias of the customer. @param [String] customer

Immutable ID of the Google Workspace account.

@param [String] domain_alias_name

Name of domain alias to be retrieved.

@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::AdminDirectoryV1::DomainAlias] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::DomainAlias]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 968
def get_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::DomainAlias::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::DomainAlias
  command.params['customer'] = customer unless customer.nil?
  command.params['domainAliasName'] = domain_alias_name unless domain_alias_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_group(group_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a group's properties. @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique 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::AdminDirectoryV1::Group] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::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

# File lib/google/apis/admin_directory_v1/service.rb, line 1222
def get_group(group_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/groups/{groupKey}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Group::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Group
  command.params['groupKey'] = group_key unless group_key.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_member(group_key, member_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a group member's properties. @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique group ID.

@param [String] member_key

Identifies the group member in the API request. A group member can be a user
or another group. The value can be the member's (group or user) primary email
address, alias, or unique 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::AdminDirectoryV1::Member] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Member]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1547
def get_member(group_key, member_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/groups/{groupKey}/members/{memberKey}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Member::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Member
  command.params['groupKey'] = group_key unless group_key.nil?
  command.params['memberKey'] = member_key unless member_key.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_mobile_device(customer_id, resource_id, projection: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a mobile device's properties. @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [String] resource_id

The unique ID the API service uses to identify the mobile device.

@param [String] projection

Restrict information returned to a set of selected fields.

@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::AdminDirectoryV1::MobileDevice] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::MobileDevice]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1851
def get_mobile_device(customer_id, resource_id, projection: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::MobileDevice::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::MobileDevice
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['resourceId'] = resource_id unless resource_id.nil?
  command.query['projection'] = projection unless projection.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_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves an organizational unit. @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [String] org_unit_path

The full path of the organizational unit or its unique 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::AdminDirectoryV1::OrgUnit] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::OrgUnit]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1975
def get_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/orgunits/{+orgUnitPath}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::OrgUnit
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['orgUnitPath'] = org_unit_path unless org_unit_path.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_resource_building(customer, building_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a building. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] building_id

The unique ID of the building to retrieve.

@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::AdminDirectoryV1::Building] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Building]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2228
def get_resource_building(customer, building_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Building::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Building
  command.params['customer'] = customer unless customer.nil?
  command.params['buildingId'] = building_id unless building_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
get_resource_feature(customer, feature_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a feature. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] feature_key

The unique ID of the feature to retrieve.

@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::AdminDirectoryV1::Feature] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Feature]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2692
def get_resource_feature(customer, feature_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/resources/features/{featureKey}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Feature::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Feature
  command.params['customer'] = customer unless customer.nil?
  command.params['featureKey'] = feature_key unless feature_key.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_role(customer, role_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a role. @param [String] customer

Immutable ID of the Google Workspace account.

@param [String] role_id

Immutable ID of the role.

@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::AdminDirectoryV1::Role] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Role]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3082
def get_role(customer, role_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/roles/{roleId}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Role::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Role
  command.params['customer'] = customer unless customer.nil?
  command.params['roleId'] = role_id unless role_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
get_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a role assignment. @param [String] customer

Immutable ID of the Google Workspace account.

@param [String] role_assignment_id

Immutable ID of the role assignment.

@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::AdminDirectoryV1::RoleAssignment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::RoleAssignment]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2941
def get_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::RoleAssignment::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::RoleAssignment
  command.params['customer'] = customer unless customer.nil?
  command.params['roleAssignmentId'] = role_assignment_id unless role_assignment_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
get_schema(customer_id, schema_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a schema. @param [String] customer_id

Immutable ID of the Google Workspace account.

@param [String] schema_key

Name or immutable ID of the schema.

@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::AdminDirectoryV1::Schema] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Schema]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3287
def get_schema(customer_id, schema_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/schemas/{schemaKey}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Schema
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['schemaKey'] = schema_key unless schema_key.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_token(user_key, client_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets information about an access token issued by a user. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [String] client_id

The Client ID of the application the token is issued to.

@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::AdminDirectoryV1::Token] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Token]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3488
def get_token(user_key, client_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/tokens/{clientId}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Token::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Token
  command.params['userKey'] = user_key unless user_key.nil?
  command.params['clientId'] = client_id unless client_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
get_user(user_key, custom_field_mask: nil, projection: nil, view_type: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a user. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [String] custom_field_mask

A comma-separated list of schema names. All fields from these schemas are
fetched. This should only be set when `projection=custom`.

@param [String] projection

What subset of fields to fetch for this user.

@param [String] view_type

Whether to fetch the administrator-only or domain-wide public view of the user.
For more information, see [Retrieve a user as a non-administrator](/admin-sdk/
directory/v1/guides/manage-users#retrieve_users_non_admin).

@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::AdminDirectoryV1::User] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::User]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3618
def get_user(user_key, custom_field_mask: nil, projection: nil, view_type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::User::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::User
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['customFieldMask'] = custom_field_mask unless custom_field_mask.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['viewType'] = view_type unless view_type.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_user_photo(user_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves the user's photo. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user 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::AdminDirectoryV1::UserPhoto] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::UserPhoto]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 4160
def get_user_photo(user_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/photos/thumbnail', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::UserPhoto
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
has_member_member(group_key, member_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Checks whether the given user is a member of the group. Membership can be direct or nested. @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique group ID.

@param [String] member_key

Identifies the user member in the API request. The value can be the user's
primary email address, alias, or unique 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::AdminDirectoryV1::MembersHasMember] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::MembersHasMember]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1583
def has_member_member(group_key, member_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::MembersHasMember::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::MembersHasMember
  command.params['groupKey'] = group_key unless group_key.nil?
  command.params['memberKey'] = member_key unless member_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
insert_domain(customer, domains_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Inserts a domain of the customer. @param [String] customer

Immutable ID of the Google Workspace account.

@param [Google::Apis::AdminDirectoryV1::Domains] domains_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::AdminDirectoryV1::Domains] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Domains]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1130
def insert_domain(customer, domains_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/domains', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Domains::Representation
  command.request_object = domains_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Domains::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Domains
  command.params['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
insert_domain_alias(customer, domain_alias_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Inserts a domain alias of the customer. @param [String] customer

Immutable ID of the Google Workspace account.

@param [Google::Apis::AdminDirectoryV1::DomainAlias] domain_alias_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::AdminDirectoryV1::DomainAlias] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::DomainAlias]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1000
def insert_domain_alias(customer, domain_alias_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/domainaliases', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::DomainAlias::Representation
  command.request_object = domain_alias_object
  command.response_representation = Google::Apis::AdminDirectoryV1::DomainAlias::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::DomainAlias
  command.params['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
insert_group(group_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates a group. @param [Google::Apis::AdminDirectoryV1::Group] group_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::AdminDirectoryV1::Group] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::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

# File lib/google/apis/admin_directory_v1/service.rb, line 1251
def insert_group(group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/groups', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Group::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Group
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
insert_group_alias(group_key, alias_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Adds an alias for the group. @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique group ID.

@param [Google::Apis::AdminDirectoryV1::Alias] alias_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::AdminDirectoryV1::Alias] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Alias]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1445
def insert_group_alias(group_key, alias_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/groups/{groupKey}/aliases', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Alias::Representation
  command.request_object = alias_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Alias::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Alias
  command.params['groupKey'] = group_key unless group_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
insert_member(group_key, member_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Adds a user to the specified group. @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique group ID.

@param [Google::Apis::AdminDirectoryV1::Member] member_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::AdminDirectoryV1::Member] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Member]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1616
def insert_member(group_key, member_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/groups/{groupKey}/members', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Member::Representation
  command.request_object = member_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Member::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Member
  command.params['groupKey'] = group_key unless group_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
insert_org_unit(customer_id, org_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Adds an organizational unit. @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_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::AdminDirectoryV1::OrgUnit] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::OrgUnit]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2010
def insert_org_unit(customer_id, org_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/orgunits', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
  command.request_object = org_unit_object
  command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::OrgUnit
  command.params['customerId'] = customer_id unless customer_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
insert_resource_building(customer, building_object = nil, coordinates_source: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Inserts a building. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [Google::Apis::AdminDirectoryV1::Building] building_object @param [String] coordinates_source

Source from which Building.coordinates are derived.

@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::AdminDirectoryV1::Building] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Building]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2264
def insert_resource_building(customer, building_object = nil, coordinates_source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/resources/buildings', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Building::Representation
  command.request_object = building_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Building::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Building
  command.params['customer'] = customer unless customer.nil?
  command.query['coordinatesSource'] = coordinates_source unless coordinates_source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
insert_resource_feature(customer, feature_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Inserts a feature. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [Google::Apis::AdminDirectoryV1::Feature] feature_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::AdminDirectoryV1::Feature] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Feature]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2726
def insert_resource_feature(customer, feature_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/resources/features', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Feature::Representation
  command.request_object = feature_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Feature::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Feature
  command.params['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
insert_role(customer, role_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates a role. @param [String] customer

Immutable ID of the Google Workspace account.

@param [Google::Apis::AdminDirectoryV1::Role] role_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::AdminDirectoryV1::Role] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Role]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3114
def insert_role(customer, role_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/roles', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Role::Representation
  command.request_object = role_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Role::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Role
  command.params['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
insert_role_assignment(customer, role_assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates a role assignment. @param [String] customer

Immutable ID of the Google Workspace account.

@param [Google::Apis::AdminDirectoryV1::RoleAssignment] role_assignment_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::AdminDirectoryV1::RoleAssignment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::RoleAssignment]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2973
def insert_role_assignment(customer, role_assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/roleassignments', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::RoleAssignment::Representation
  command.request_object = role_assignment_object
  command.response_representation = Google::Apis::AdminDirectoryV1::RoleAssignment::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::RoleAssignment
  command.params['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
insert_schema(customer_id, schema_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates a schema. @param [String] customer_id

Immutable ID of the Google Workspace account.

@param [Google::Apis::AdminDirectoryV1::Schema] schema_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::AdminDirectoryV1::Schema] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Schema]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3319
def insert_schema(customer_id, schema_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/schemas', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
  command.request_object = schema_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Schema
  command.params['customerId'] = customer_id unless customer_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
insert_user(user_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates a user. @param [Google::Apis::AdminDirectoryV1::User] user_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::AdminDirectoryV1::User] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::User]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3650
def insert_user(user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/users', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::AdminDirectoryV1::User::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::User
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
insert_user_alias(user_key, alias_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Adds an alias. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [Google::Apis::AdminDirectoryV1::Alias] alias_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::AdminDirectoryV1::Alias] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Alias]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 4028
def insert_user_alias(user_key, alias_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/aliases', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Alias::Representation
  command.request_object = alias_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Alias::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Alias
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
invalidate_verification_code(user_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Invalidates the current backup verification codes for the user. @param [String] user_key

Email or immutable ID of the 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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 4287
def invalidate_verification_code(user_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/verificationCodes/invalidate', options)
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
issue_customer_device_chromeo_command(customer_id, device_id, directory_chromeosdevices_issue_command_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Issues a command for the device to execute. @param [String] customer_id

Immutable. Immutable ID of the Google Workspace account.

@param [String] device_id

Immutable. Immutable ID of Chrome OS Device.

@param [Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesIssueCommandRequest] directory_chromeosdevices_issue_command_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::AdminDirectoryV1::DirectoryChromeosdevicesIssueCommandResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesIssueCommandResponse]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 475
def issue_customer_device_chromeo_command(customer_id, device_id, directory_chromeosdevices_issue_command_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesIssueCommandRequest::Representation
  command.request_object = directory_chromeosdevices_issue_command_request_object
  command.response_representation = Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesIssueCommandResponse::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesIssueCommandResponse
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['deviceId'] = device_id unless device_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
list_asps(user_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists the ASPs issued by a user. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user 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::AdminDirectoryV1::Asps] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Asps]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 141
def list_asps(user_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/asps', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Asps::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Asps
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_calendar_resources(customer, max_results: nil, order_by: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a list of calendar resources for an account. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [Fixnum] max_results

Maximum number of results to return.

@param [String] order_by

Field(s) to sort results by in either ascending or descending order. Supported
fields include `resourceId`, `resourceName`, `capacity`, `buildingId`, and `
floorName`. If no order is specified, defaults to ascending. Should be of the
form "field [asc|desc], field [asc|desc], ...". For example `buildingId,
capacity desc` would return results sorted first by `buildingId` in ascending
order then by `capacity` in descending order.

@param [String] page_token

Token to specify the next page in the list.

@param [String] query

String query used to filter results. Should be of the form "field operator
value" where field can be any of supported fields and operators can be any of
supported operations. Operators include '=' for exact match, '!=' for mismatch
and ':' for prefix match or HAS match where applicable. For prefix match, the
value should always be followed by a *. Logical operators NOT and AND are
supported (in this order of precedence). Supported fields include `
generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `
featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For
example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`.

@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::AdminDirectoryV1::CalendarResources] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::CalendarResources]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2543
def list_calendar_resources(customer, max_results: nil, order_by: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/resources/calendars', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResources::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::CalendarResources
  command.params['customer'] = customer unless customer.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.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
list_chrome_os_devices(customer_id, max_results: nil, order_by: nil, org_unit_path: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a paginated list of Chrome OS devices within an account. @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [Fixnum] max_results

Maximum number of results to return.

@param [String] order_by

Device property to use for sorting results.

@param [String] org_unit_path

The full path of the organizational unit or its unique ID.

@param [String] page_token

The `pageToken` query parameter is used to request the next page of query
results. The follow-on request's `pageToken` query parameter is the `
nextPageToken` from your previous response.

@param [String] projection

Restrict information returned to a set of selected fields.

@param [String] query

Search string in the format given at http://support.google.com/chromeos/a/bin/
answer.py?answer=1698333

@param [String] sort_order

Whether to return results in ascending or descending order. Must be used with
the `orderBy` parameter.

@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::AdminDirectoryV1::ChromeOsDevices] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::ChromeOsDevices]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 309
def list_chrome_os_devices(customer_id, max_results: nil, order_by: nil, org_unit_path: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/devices/chromeos', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevices::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::ChromeOsDevices
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['orgUnitPath'] = org_unit_path unless org_unit_path.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['query'] = query unless query.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_customer_chrome_printer_printer_models(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists the supported printer models. @param [String] parent

Required. The name of the customer who owns this collection of printers.
Format: customers/`customer_id`

@param [String] filter

Filer to list only models by a given manufacturer in format: "manufacturer:
Brother". Search syntax is shared between this api and Admin Console printers
pages.

@param [Fixnum] page_size

The maximum number of objects to return. The service may return fewer than
this value.

@param [String] page_token

A page token, received from a previous call.

@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::AdminDirectoryV1::ListPrinterModelsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::ListPrinterModelsResponse]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 860
def list_customer_chrome_printer_printer_models(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/{+parent}/chrome/printers:listPrinterModels', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::ListPrinterModelsResponse::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::ListPrinterModelsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.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
list_customer_chrome_printers(parent, filter: nil, org_unit_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

List printers configs. @param [String] parent

Required. The name of the customer who owns this collection of printers.
Format: customers/`customer_id`

@param [String] filter

Search query. Search syntax is shared between this api and Admin Console
printers pages.

@param [String] org_unit_id

Organization Unit that we want to list the printers for. When org_unit is not
present in the request then all printers of the customer are returned (or
filtered). When org_unit is present in the request then only printers
available to this OU will be returned (owned or inherited). You may see if
printer is owned or inherited for this OU by looking at Printer.org_unit_id.

@param [Fixnum] page_size

The maximum number of objects to return. The service may return fewer than
this value.

@param [String] page_token

A page token, received from a previous call.

@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::AdminDirectoryV1::ListPrintersResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::ListPrintersResponse]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 816
def list_customer_chrome_printers(parent, filter: nil, org_unit_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/{+parent}/chrome/printers', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::ListPrintersResponse::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::ListPrintersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orgUnitId'] = org_unit_id unless org_unit_id.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
list_domain_aliases(customer, parent_domain_name: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists the domain aliases of the customer. @param [String] customer

Immutable ID of the Google Workspace account.

@param [String] parent_domain_name

Name of the parent domain for which domain aliases are to be fetched.

@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::AdminDirectoryV1::DomainAliases] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::DomainAliases]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1034
def list_domain_aliases(customer, parent_domain_name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/domainaliases', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::DomainAliases::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::DomainAliases
  command.params['customer'] = customer unless customer.nil?
  command.query['parentDomainName'] = parent_domain_name unless parent_domain_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_domains(customer, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists the domains of the customer. @param [String] customer

Immutable ID of the Google Workspace account.

@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::AdminDirectoryV1::Domains2] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Domains2]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1162
def list_domains(customer, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/domains', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Domains2::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Domains2
  command.params['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
list_group_aliases(group_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists all aliases for a group. @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique 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::AdminDirectoryV1::Aliases] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Aliases]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1478
def list_group_aliases(group_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/groups/{groupKey}/aliases', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Aliases::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Aliases
  command.params['groupKey'] = group_key unless group_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_groups(customer: nil, domain: nil, max_results: nil, order_by: nil, page_token: nil, query: nil, sort_order: nil, user_key: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves all groups of a domain or of a user given a userKey (paginated). @param [String] customer

The unique ID for the customer's Google Workspace account. In case of a multi-
domain account, to fetch all groups for a customer, fill this field instead of
domain. As an account administrator, you can also use the `my_customer` alias
to represent your account's `customerId`. The `customerId` is also returned as
part of the [Users](/admin-sdk/directory/v1/reference/users)

@param [String] domain

The domain name. Use this field to get fields from only one domain. To return
all domains for a customer account, use the `customer` query parameter instead.

@param [Fixnum] max_results

Maximum number of results to return. Max allowed value is 200.

@param [String] order_by

Column to use for sorting results

@param [String] page_token

Token to specify next page in the list

@param [String] query

Query string search. Should be of the form "". Complete documentation is at
https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups

@param [String] sort_order

Whether to return results in ascending or descending order. Only of use when
orderBy is also used

@param [String] user_key

Email or immutable ID of the user if only those groups are to be listed, the
given user is a member of. If it's an ID, it should match with the ID of the
user 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::AdminDirectoryV1::Groups] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Groups]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1305
def list_groups(customer: nil, domain: nil, max_results: nil, order_by: nil, page_token: nil, query: nil, sort_order: nil, user_key: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/groups', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Groups::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Groups
  command.query['customer'] = customer unless customer.nil?
  command.query['domain'] = domain unless domain.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_members(group_key, include_derived_membership: nil, max_results: nil, page_token: nil, roles: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a paginated list of all members in a group. @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique group ID.

@param [Boolean] include_derived_membership

Whether to list indirect memberships. Default: false.

@param [Fixnum] max_results

Maximum number of results to return. Max allowed value is 200.

@param [String] page_token

Token to specify next page in the list.

@param [String] roles

The `roles` query parameter allows you to retrieve group members by role.
Allowed values are `OWNER`, `MANAGER`, and `MEMBER`.

@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::AdminDirectoryV1::Members] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Members]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1658
def list_members(group_key, include_derived_membership: nil, max_results: nil, page_token: nil, roles: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/groups/{groupKey}/members', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Members::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Members
  command.params['groupKey'] = group_key unless group_key.nil?
  command.query['includeDerivedMembership'] = include_derived_membership unless include_derived_membership.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['roles'] = roles unless roles.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_mobile_devices(customer_id, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a paginated list of all mobile devices for an account. @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [Fixnum] max_results

Maximum number of results to return. Max allowed value is 100.

@param [String] order_by

Device property to use for sorting results.

@param [String] page_token

Token to specify next page in the list

@param [String] projection

Restrict information returned to a set of selected fields.

@param [String] query

Search string in the format given at https://developers.google.com/admin-sdk/
directory/v1/search-operators

@param [String] sort_order

Whether to return results in ascending or descending order. Must be used with
the `orderBy` parameter.

@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::AdminDirectoryV1::MobileDevices] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::MobileDevices]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1900
def list_mobile_devices(customer_id, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/devices/mobile', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::MobileDevices::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::MobileDevices
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['query'] = query unless query.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_org_units(customer_id, org_unit_path: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a list of all organizational units for an account. @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [String] org_unit_path

The full path to the organizational unit or its unique ID. Returns the
children of the specified organizational unit.

@param [String] type

Whether to return all sub-organizations or just immediate children.

@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::AdminDirectoryV1::OrgUnits] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::OrgUnits]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2050
def list_org_units(customer_id, org_unit_path: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/orgunits', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnits::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::OrgUnits
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.query['orgUnitPath'] = org_unit_path unless org_unit_path.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_privileges(customer, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a paginated list of all privileges for a customer. @param [String] customer

Immutable ID of the Google Workspace account.

@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::AdminDirectoryV1::Privileges] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Privileges]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2161
def list_privileges(customer, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/roles/ALL/privileges', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Privileges::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Privileges
  command.params['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
list_resource_buildings(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a list of buildings for an account. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [Fixnum] max_results

Maximum number of results to return.

@param [String] page_token

Token to specify the next page in the list.

@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::AdminDirectoryV1::Buildings] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Buildings]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2303
def list_resource_buildings(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/resources/buildings', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Buildings::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Buildings
  command.params['customer'] = customer unless customer.nil?
  command.query['maxResults'] = max_results unless max_results.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
list_resource_features(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a list of features for an account. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [Fixnum] max_results

Maximum number of results to return.

@param [String] page_token

Token to specify the next page in the list.

@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::AdminDirectoryV1::Features] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Features]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2764
def list_resource_features(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/resources/features', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Features::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Features
  command.params['customer'] = customer unless customer.nil?
  command.query['maxResults'] = max_results unless max_results.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
list_role_assignments(customer, max_results: nil, page_token: nil, role_id: nil, user_key: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a paginated list of all roleAssignments. @param [String] customer

Immutable ID of the Google Workspace account.

@param [Fixnum] max_results

Maximum number of results to return.

@param [String] page_token

Token to specify the next page in the list.

@param [String] role_id

Immutable ID of a role. If included in the request, returns only role
assignments containing this role ID.

@param [String] user_key

The user's primary email address, alias email address, or unique user ID. If
included in the request, returns role assignments only for this 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::AdminDirectoryV1::RoleAssignments] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::RoleAssignments]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3015
def list_role_assignments(customer, max_results: nil, page_token: nil, role_id: nil, user_key: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/roleassignments', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::RoleAssignments::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::RoleAssignments
  command.params['customer'] = customer unless customer.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['roleId'] = role_id unless role_id.nil?
  command.query['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_roles(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a paginated list of all the roles in a domain. @param [String] customer

Immutable ID of the Google Workspace account.

@param [Fixnum] max_results

Maximum number of results to return.

@param [String] page_token

Token to specify the next page in the list.

@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::AdminDirectoryV1::Roles] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Roles]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3150
def list_roles(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/roles', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Roles::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Roles
  command.params['customer'] = customer unless customer.nil?
  command.query['maxResults'] = max_results unless max_results.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
list_schemas(customer_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves all schemas for a customer. @param [String] customer_id

Immutable ID of the Google Workspace account.

@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::AdminDirectoryV1::Schemas] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Schemas]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3351
def list_schemas(customer_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/schemas', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Schemas::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Schemas
  command.params['customerId'] = customer_id unless customer_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
list_tokens(user_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Returns the set of tokens specified user has issued to 3rd party applications. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user 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::AdminDirectoryV1::Tokens] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Tokens]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3520
def list_tokens(user_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/tokens', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Tokens::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Tokens
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_user_aliases(user_key, event: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists all aliases for a user. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [String] event

Events to watch for.

@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::AdminDirectoryV1::Aliases] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Aliases]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 4063
def list_user_aliases(user_key, event: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/aliases', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Aliases::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Aliases
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['event'] = event unless event.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_users(custom_field_mask: nil, customer: nil, domain: nil, event: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, show_deleted: nil, sort_order: nil, view_type: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a paginated list of either deleted users or all users in a domain. @param [String] custom_field_mask

A comma-separated list of schema names. All fields from these schemas are
fetched. This should only be set when `projection=custom`.

@param [String] customer

The unique ID for the customer's Google Workspace account. In case of a multi-
domain account, to fetch all groups for a customer, fill this field instead of
domain. You can also use the `my_customer` alias to represent your account's `
customerId`. The `customerId` is also returned as part of the [Users resource](
/admin-sdk/directory/v1/reference/users). Either the `customer` or the `domain`
parameter must be provided.

@param [String] domain

The domain name. Use this field to get fields from only one domain. To return
all domains for a customer account, use the `customer` query parameter instead.
Either the `customer` or the `domain` parameter must be provided.

@param [String] event

Event on which subscription is intended (if subscribing)

@param [Fixnum] max_results

Maximum number of results to return.

@param [String] order_by

Property to use for sorting results.

@param [String] page_token

Token to specify next page in the list

@param [String] projection

What subset of fields to fetch for this user.

@param [String] query

Query string for searching user fields. For more information on constructing
user queries, see [Search for Users](/admin-sdk/directory/v1/guides/search-
users).

@param [String] show_deleted

If set to `true`, retrieves the list of deleted users. (Default: `false`)

@param [String] sort_order

Whether to return results in ascending or descending order.

@param [String] view_type

Whether to fetch the administrator-only or domain-wide public view of the user.
For more information, see [Retrieve a user as a non-administrator](/admin-sdk/
directory/v1/guides/manage-users#retrieve_users_non_admin).

@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::AdminDirectoryV1::Users] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Users]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3715
def list_users(custom_field_mask: nil, customer: nil, domain: nil, event: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, show_deleted: nil, sort_order: nil, view_type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/users', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Users::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Users
  command.query['customFieldMask'] = custom_field_mask unless custom_field_mask.nil?
  command.query['customer'] = customer unless customer.nil?
  command.query['domain'] = domain unless domain.nil?
  command.query['event'] = event unless event.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['query'] = query unless query.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['viewType'] = view_type unless view_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_verification_codes(user_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Returns the current set of valid backup verification codes for the specified user. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user 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::AdminDirectoryV1::VerificationCodes] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::VerificationCodes]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 4317
def list_verification_codes(user_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/verificationCodes', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::VerificationCodes::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::VerificationCodes
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
make_user_admin(user_key, user_make_admin_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Makes a user a super administrator. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [Google::Apis::AdminDirectoryV1::UserMakeAdmin] user_make_admin_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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3758
def make_user_admin(user_key, user_make_admin_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/makeAdmin', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::UserMakeAdmin::Representation
  command.request_object = user_make_admin_object
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
move_chromeosdevice_devices_to_ou(customer_id, org_unit_path, chrome_os_move_devices_to_ou_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once. @param [String] customer_id

Immutable ID of the Google Workspace account

@param [String] org_unit_path

Full path of the target organizational unit or its ID

@param [Google::Apis::AdminDirectoryV1::ChromeOsMoveDevicesToOu] chrome_os_move_devices_to_ou_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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 350
def move_chromeosdevice_devices_to_ou(customer_id, org_unit_path, chrome_os_move_devices_to_ou_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::ChromeOsMoveDevicesToOu::Representation
  command.request_object = chrome_os_move_devices_to_ou_object
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.query['orgUnitPath'] = org_unit_path unless org_unit_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Patches a calendar resource. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] calendar_resource_id

The unique ID of the calendar resource to update.

@param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_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::AdminDirectoryV1::CalendarResource] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::CalendarResource]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2582
def patch_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
  command.request_object = calendar_resource_object
  command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::CalendarResource
  command.params['customer'] = customer unless customer.nil?
  command.params['calendarResourceId'] = calendar_resource_id unless calendar_resource_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
patch_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a device's updatable properties, such as `annotatedUser`, ` annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch). @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [String] device_id

The unique ID of the device. The `deviceId`s are returned in the response from
the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list)
method.

@param [Google::Apis::AdminDirectoryV1::ChromeOsDevice] chrome_os_device_object @param [String] projection

Restrict information returned to a set of selected fields.

@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::AdminDirectoryV1::ChromeOsDevice] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::ChromeOsDevice]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 393
def patch_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation
  command.request_object = chrome_os_device_object
  command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::ChromeOsDevice
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Patches a customer. @param [String] customer_key

Id of the customer to be updated

@param [Google::Apis::AdminDirectoryV1::Customer] customer_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::AdminDirectoryV1::Customer] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Customer]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 575
def patch_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/customers/{customerKey}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Customer::Representation
  command.request_object = customer_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Customer::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Customer
  command.params['customerKey'] = customer_key unless customer_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_customer_chrome_printer(name, printer_object = nil, clear_mask: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a `Printer` resource. @param [String] name

The resource name of the Printer object, in the format customers/`customer-id`/
printers/`printer-id` (During printer creation leave empty)

@param [Google::Apis::AdminDirectoryV1::Printer] printer_object @param [String] clear_mask

The list of fields to be cleared. Note, some of the fields are read only and
cannot be updated. Values for not specified fields will be patched.

@param [String] update_mask

The list of fields to be updated. Note, some of the fields are read only and
cannot be updated. Values for not specified fields will be patched.

@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::AdminDirectoryV1::Printer] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Printer]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 901
def patch_customer_chrome_printer(name, printer_object = nil, clear_mask: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/{+name}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Printer::Representation
  command.request_object = printer_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Printer::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Printer
  command.params['name'] = name unless name.nil?
  command.query['clearMask'] = clear_mask unless clear_mask.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
patch_group(group_key, group_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a group's properties. This method supports [patch semantics](/admin- sdk/directory/v1/guides/performance#patch). @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique group ID.

@param [Google::Apis::AdminDirectoryV1::Group] group_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::AdminDirectoryV1::Group] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::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

# File lib/google/apis/admin_directory_v1/service.rb, line 1345
def patch_group(group_key, group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/groups/{groupKey}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Group::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Group
  command.params['groupKey'] = group_key unless group_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates the membership properties of a user in the specified group. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance# patch). @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique group ID.

@param [String] member_key

Identifies the group member in the API request. A group member can be a user
or another group. The value can be the member's (group or user) primary email
address, alias, or unique ID.

@param [Google::Apis::AdminDirectoryV1::Member] member_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::AdminDirectoryV1::Member] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Member]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1700
def patch_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/groups/{groupKey}/members/{memberKey}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Member::Representation
  command.request_object = member_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Member::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Member
  command.params['groupKey'] = group_key unless group_key.nil?
  command.params['memberKey'] = member_key unless member_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates an organizational unit. This method supports [patch semantics](/admin- sdk/directory/v1/guides/performance#patch) @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [String] org_unit_path

The full path of the organizational unit or its unique ID.

@param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_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::AdminDirectoryV1::OrgUnit] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::OrgUnit]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2089
def patch_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/customer/{customerId}/orgunits/{+orgUnitPath}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
  command.request_object = org_unit_object
  command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::OrgUnit
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['orgUnitPath'] = org_unit_path unless org_unit_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_resource_building(customer, building_id, building_object = nil, coordinates_source: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Patches a building. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] building_id

The id of the building to update.

@param [Google::Apis::AdminDirectoryV1::Building] building_object @param [String] coordinates_source

Source from which Building.coordinates are derived.

@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::AdminDirectoryV1::Building] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Building]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2342
def patch_resource_building(customer, building_id, building_object = nil, coordinates_source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Building::Representation
  command.request_object = building_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Building::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Building
  command.params['customer'] = customer unless customer.nil?
  command.params['buildingId'] = building_id unless building_id.nil?
  command.query['coordinatesSource'] = coordinates_source unless coordinates_source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_resource_feature(customer, feature_key, feature_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Patches a feature. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] feature_key

The unique ID of the feature to update.

@param [Google::Apis::AdminDirectoryV1::Feature] feature_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::AdminDirectoryV1::Feature] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Feature]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2801
def patch_resource_feature(customer, feature_key, feature_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/customer/{customer}/resources/features/{featureKey}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Feature::Representation
  command.request_object = feature_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Feature::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Feature
  command.params['customer'] = customer unless customer.nil?
  command.params['featureKey'] = feature_key unless feature_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Patches a role. @param [String] customer

Immutable ID of the Google Workspace account.

@param [String] role_id

Immutable ID of the role.

@param [Google::Apis::AdminDirectoryV1::Role] role_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::AdminDirectoryV1::Role] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Role]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3185
def patch_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/customer/{customer}/roles/{roleId}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Role::Representation
  command.request_object = role_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Role::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Role
  command.params['customer'] = customer unless customer.nil?
  command.params['roleId'] = role_id unless role_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
patch_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Patches a schema. @param [String] customer_id

Immutable ID of the Google Workspace account.

@param [String] schema_key

Name or immutable ID of the schema.

@param [Google::Apis::AdminDirectoryV1::Schema] schema_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::AdminDirectoryV1::Schema] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Schema]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3384
def patch_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/customer/{customerId}/schemas/{schemaKey}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
  command.request_object = schema_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Schema
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['schemaKey'] = schema_key unless schema_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_user(user_key, user_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a user using patch semantics. The update method should be used instead, since it also supports patch semantics and has better performance. This method is unable to clear fields that contain repeated objects (`addresses`, ` phones`, etc). Use the update method instead. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [Google::Apis::AdminDirectoryV1::User] user_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::AdminDirectoryV1::User] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::User]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3793
def patch_user(user_key, user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/users/{userKey}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::AdminDirectoryV1::User::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::User
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Adds a photo for the user. This method supports [patch semantics](/admin-sdk/ directory/v1/guides/performance#patch). @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [Google::Apis::AdminDirectoryV1::UserPhoto] user_photo_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::AdminDirectoryV1::UserPhoto] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::UserPhoto]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 4193
def patch_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'admin/directory/v1/users/{userKey}/photos/thumbnail', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation
  command.request_object = user_photo_object
  command.response_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::UserPhoto
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
rename_resource_feature(customer, old_name, feature_rename_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Renames a feature. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] old_name

The unique ID of the feature to rename.

@param [Google::Apis::AdminDirectoryV1::FeatureRename] feature_rename_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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2839
def rename_resource_feature(customer, old_name, feature_rename_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::FeatureRename::Representation
  command.request_object = feature_rename_object
  command.params['customer'] = customer unless customer.nil?
  command.params['oldName'] = old_name unless old_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
sign_user_out(user_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Signs a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again. @param [String] user_key

Identifies the target user in the API request. The value can be the user's
primary email address, alias email address, or unique user 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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3827
def sign_user_out(user_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/signOut', options)
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
stop_channel(channel_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Stops watching resources through this channel. @param [Google::Apis::AdminDirectoryV1::Channel] channel_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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 170
def stop_channel(channel_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory_v1/channels/stop', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Channel::Representation
  command.request_object = channel_object
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
turn_two_step_verification_off(user_key, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Turns off 2-Step Verification for user. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user 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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3551
def turn_two_step_verification_off(user_key, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/twoStepVerification/turnOff', options)
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
undelete_user(user_key, user_undelete_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Undeletes a deleted user. @param [String] user_key

The immutable id of the user

@param [Google::Apis::AdminDirectoryV1::UserUndelete] user_undelete_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 [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3856
def undelete_user(user_key, user_undelete_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/undelete', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::UserUndelete::Representation
  command.request_object = user_undelete_object
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
update_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a calendar resource. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] calendar_resource_id

The unique ID of the calendar resource to update.

@param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_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::AdminDirectoryV1::CalendarResource] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::CalendarResource]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2622
def update_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
  command.request_object = calendar_resource_object
  command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::CalendarResource
  command.params['customer'] = customer unless customer.nil?
  command.params['calendarResourceId'] = calendar_resource_id unless calendar_resource_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
update_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a device's updatable properties, such as `annotatedUser`, ` annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [String] device_id

The unique ID of the device. The `deviceId`s are returned in the response from
the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list)
method.

@param [Google::Apis::AdminDirectoryV1::ChromeOsDevice] chrome_os_device_object @param [String] projection

Restrict information returned to a set of selected fields.

@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::AdminDirectoryV1::ChromeOsDevice] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::ChromeOsDevice]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 438
def update_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation
  command.request_object = chrome_os_device_object
  command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::ChromeOsDevice
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
update_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a customer. @param [String] customer_key

Id of the customer to be updated

@param [Google::Apis::AdminDirectoryV1::Customer] customer_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::AdminDirectoryV1::Customer] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Customer]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 608
def update_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'admin/directory/v1/customers/{customerKey}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Customer::Representation
  command.request_object = customer_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Customer::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Customer
  command.params['customerKey'] = customer_key unless customer_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
update_group(group_key, group_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a group's properties. @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique group ID.

@param [Google::Apis::AdminDirectoryV1::Group] group_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::AdminDirectoryV1::Group] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::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

# File lib/google/apis/admin_directory_v1/service.rb, line 1379
def update_group(group_key, group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'admin/directory/v1/groups/{groupKey}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Group::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Group
  command.params['groupKey'] = group_key unless group_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
update_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates the membership of a user in the specified group. @param [String] group_key

Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique group ID.

@param [String] member_key

Identifies the group member in the API request. A group member can be a user
or another group. The value can be the member's (group or user) primary email
address, alias, or unique ID.

@param [Google::Apis::AdminDirectoryV1::Member] member_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::AdminDirectoryV1::Member] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Member]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 1739
def update_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'admin/directory/v1/groups/{groupKey}/members/{memberKey}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Member::Representation
  command.request_object = member_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Member::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Member
  command.params['groupKey'] = group_key unless group_key.nil?
  command.params['memberKey'] = member_key unless member_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
update_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates an organizational unit. @param [String] customer_id

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's `customerId`. The `customerId` is also returned as part of the [
Users resource](/admin-sdk/directory/v1/reference/users).

@param [String] org_unit_path

The full path of the organizational unit or its unique ID.

@param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_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::AdminDirectoryV1::OrgUnit] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::OrgUnit]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2128
def update_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'admin/directory/v1/customer/{customerId}/orgunits/{+orgUnitPath}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
  command.request_object = org_unit_object
  command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::OrgUnit
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['orgUnitPath'] = org_unit_path unless org_unit_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
update_resource_building(customer, building_id, building_object = nil, coordinates_source: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a building. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] building_id

The id of the building to update.

@param [Google::Apis::AdminDirectoryV1::Building] building_object @param [String] coordinates_source

Source from which Building.coordinates are derived.

@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::AdminDirectoryV1::Building] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Building]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2383
def update_resource_building(customer, building_id, building_object = nil, coordinates_source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Building::Representation
  command.request_object = building_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Building::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Building
  command.params['customer'] = customer unless customer.nil?
  command.params['buildingId'] = building_id unless building_id.nil?
  command.query['coordinatesSource'] = coordinates_source unless coordinates_source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
update_resource_feature(customer, feature_key, feature_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a feature. @param [String] customer

The unique ID for the customer's Google Workspace account. As an account
administrator, you can also use the `my_customer` alias to represent your
account's customer ID.

@param [String] feature_key

The unique ID of the feature to update.

@param [Google::Apis::AdminDirectoryV1::Feature] feature_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::AdminDirectoryV1::Feature] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Feature]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 2875
def update_resource_feature(customer, feature_key, feature_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'admin/directory/v1/customer/{customer}/resources/features/{featureKey}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Feature::Representation
  command.request_object = feature_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Feature::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Feature
  command.params['customer'] = customer unless customer.nil?
  command.params['featureKey'] = feature_key unless feature_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
update_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a role. @param [String] customer

Immutable ID of the Google Workspace account.

@param [String] role_id

Immutable ID of the role.

@param [Google::Apis::AdminDirectoryV1::Role] role_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::AdminDirectoryV1::Role] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Role]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3221
def update_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'admin/directory/v1/customer/{customer}/roles/{roleId}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Role::Representation
  command.request_object = role_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Role::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Role
  command.params['customer'] = customer unless customer.nil?
  command.params['roleId'] = role_id unless role_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
update_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a schema. @param [String] customer_id

Immutable ID of the Google Workspace account.

@param [String] schema_key

Name or immutable ID of the schema.

@param [Google::Apis::AdminDirectoryV1::Schema] schema_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::AdminDirectoryV1::Schema] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Schema]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3420
def update_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'admin/directory/v1/customer/{customerId}/schemas/{schemaKey}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
  command.request_object = schema_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Schema
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['schemaKey'] = schema_key unless schema_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
update_user(user_key, user_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates a user. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [Google::Apis::AdminDirectoryV1::User] user_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::AdminDirectoryV1::User] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::User]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3890
def update_user(user_key, user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'admin/directory/v1/users/{userKey}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::AdminDirectoryV1::User::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::User
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
update_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Adds a photo for the user. @param [String] user_key

Identifies the user in the API request. The value can be the user's primary
email address, alias email address, or unique user ID.

@param [Google::Apis::AdminDirectoryV1::UserPhoto] user_photo_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::AdminDirectoryV1::UserPhoto] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::UserPhoto]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 4227
def update_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'admin/directory/v1/users/{userKey}/photos/thumbnail', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation
  command.request_object = user_photo_object
  command.response_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::UserPhoto
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
watch_user(channel_object = nil, custom_field_mask: nil, customer: nil, domain: nil, event: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, show_deleted: nil, sort_order: nil, view_type: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Watches for changes in users list. @param [Google::Apis::AdminDirectoryV1::Channel] channel_object @param [String] custom_field_mask

Comma-separated list of schema names. All fields from these schemas are
fetched. This should only be set when projection=custom.

@param [String] customer

Immutable ID of the Google Workspace account. In case of multi-domain, to
fetch all users for a customer, fill this field instead of domain.

@param [String] domain

Name of the domain. Fill this field to get users from only this domain. To
return all users in a multi-domain fill customer field instead."

@param [String] event

Events to watch for.

@param [Fixnum] max_results

Maximum number of results to return.

@param [String] order_by

Column to use for sorting results

@param [String] page_token

Token to specify next page in the list

@param [String] projection

What subset of fields to fetch for this user.

@param [String] query

Query string search. Should be of the form "". Complete documentation is at
https: //developers.google.com/admin-sdk/directory/v1/guides/search-users

@param [String] show_deleted

If set to true, retrieves the list of deleted users. (Default: false)

@param [String] sort_order

Whether to return results in ascending or descending order.

@param [String] view_type

Whether to fetch the administrator-only or domain-wide public view of the user.
For more information, see [Retrieve a user as a non-administrator](/admin-sdk/
directory/v1/guides/manage-users#retrieve_users_non_admin).

@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::AdminDirectoryV1::Channel] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Channel]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 3951
def watch_user(channel_object = nil, custom_field_mask: nil, customer: nil, domain: nil, event: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, show_deleted: nil, sort_order: nil, view_type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/users/watch', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Channel::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Channel
  command.query['customFieldMask'] = custom_field_mask unless custom_field_mask.nil?
  command.query['customer'] = customer unless customer.nil?
  command.query['domain'] = domain unless domain.nil?
  command.query['event'] = event unless event.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['query'] = query unless query.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['viewType'] = view_type unless view_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
watch_user_alias(user_key, channel_object = nil, event: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Watches for changes in users list. @param [String] user_key

Email or immutable ID of the user

@param [Google::Apis::AdminDirectoryV1::Channel] channel_object @param [String] event

Events to watch for.

@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::AdminDirectoryV1::Channel] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdminDirectoryV1::Channel]

@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

# File lib/google/apis/admin_directory_v1/service.rb, line 4097
def watch_user_alias(user_key, channel_object = nil, event: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/aliases/watch', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Channel::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Channel
  command.params['userKey'] = user_key unless user_key.nil?
  command.query['event'] = event unless event.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 Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/admin_directory_v1/service.rb, line 4329
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end