Class: Google::Apis::AdminDirectoryV1::DirectoryService

Inherits:

Core::BaseService

Object
Core::BaseService
Google::Apis::AdminDirectoryV1::DirectoryService

show all

Defined in:: generated/google/apis/admin_directory_v1/service.rb

Overview

Admin Directory API

The Admin SDK Directory API lets you view and manage enterprise resources such as users and groups, administrative notifications, security features, and more.

Examples:

require 'google/apis/admin_directory_v1'

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

Instance Attribute Summary collapse

#key ⇒ String
API key.
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
#user_ip ⇒ String
IP address of the site where the request originates.

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

#action_chromeosdevice(customer_id, resource_id, chrome_os_device_action_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Take action on Chrome OS Device.
#action_mobile_device(customer_id, resource_id, mobile_device_action_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Take action on Mobile Device.
#calendar_resource(customer, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::CalendarResource
Inserts a calendar resource.
#delete_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Delete an ASP issued by a user.
#delete_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes a calendar resource.
#delete_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes a domain of the customer.
#delete_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes a Domain Alias of the customer.
#delete_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Delete Group.
#delete_group_alias(group_key, group_alias, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Remove a alias for the group.
#delete_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Remove membership.
#delete_mobile_device(customer_id, resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Delete Mobile Device.
#delete_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes a notification.
#delete_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Remove Organization Unit.
#delete_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes a role.
#delete_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes a role assignment.
#delete_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Delete schema.
#delete_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Delete all access tokens issued by a user for an application.
#delete_user(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Delete user.
#delete_user_alias(user_key, user_alias, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Remove a alias for the user.
#delete_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Remove photos for the user.
#generate_verification_code(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Generate new backup verification codes for the user.
#get_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Asp
Get information about an ASP issued by a user.
#get_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::CalendarResource
Retrieves a calendar resource.
#get_chrome_os_device(customer_id, device_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::ChromeOsDevice
Retrieve Chrome OS Device.
#get_customer(customer_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Customer
Retrieves a customer.
#get_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Domains
Retrieves a domain of the customer.
#get_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::DomainAlias
Retrieves a domain alias of the customer.
#get_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Group
Retrieve Group.
#get_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Member
Retrieve Group Member.
#get_mobile_device(customer_id, resource_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::MobileDevice
Retrieve Mobile Device.
#get_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Notification
Retrieves a notification.
#get_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::OrgUnit
Retrieve Organization Unit.
#get_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Role
Retrieves a role.
#get_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::RoleAssignment
Retrieve a role assignment.
#get_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Schema
Retrieve schema.
#get_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Token
Get information about an access token issued by a user.
#get_user(user_key, custom_field_mask: nil, projection: nil, view_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::User
retrieve user.
#get_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::UserPhoto
Retrieve photo of a user.
#initialize ⇒ DirectoryService constructor
A new instance of DirectoryService.
#insert_domain(customer, domains_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Domains
Inserts a domain of the customer.
#insert_domain_alias(customer, domain_alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::DomainAlias
Inserts a Domain alias of the customer.
#insert_group(group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Group
Create Group.
#insert_group_alias(group_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Alias
Add a alias for the group.
#insert_member(group_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Member
Add user to the specified group.
#insert_org_unit(customer_id, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::OrgUnit
Add Organization Unit.
#insert_role(customer, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Role
Creates a role.
#insert_role_assignment(customer, role_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::RoleAssignment
Creates a role assignment.
#insert_schema(customer_id, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Schema
Create schema.
#insert_user(user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::User
create user.
#insert_user_alias(user_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Alias
Add a alias for the user.
#invalidate_verification_code(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Invalidate the current backup verification codes for the user.
#list_asps(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Asps
List the ASPs issued by a user.
#list_calendar_resources(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::CalendarResources
Retrieves a list of calendar resources for an account.
#list_chrome_os_devices(customer_id, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::ChromeOsDevices
Retrieve all Chrome OS Devices of a customer (paginated).
#list_domain_aliases(customer, parent_domain_name: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::DomainAliases
Lists the domain aliases of the customer.
#list_domains(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Domains2
Lists the domains of the customer.
#list_group_aliases(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Aliases
List all aliases for a group.
#list_groups(customer: nil, domain: nil, max_results: nil, page_token: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Groups
Retrieve all groups in a domain (paginated).
#list_members(group_key, max_results: nil, page_token: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Members
Retrieve all members in a group (paginated).
#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::MobileDevices
Retrieve all Mobile Devices of a customer (paginated).
#list_notifications(customer, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Notifications
Retrieves a list of notifications.
#list_org_units(customer_id, org_unit_path: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::OrgUnits
Retrieve all Organization Units.
#list_privileges(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Privileges
Retrieves a paginated list of all privileges for a customer.
#list_role_assignments(customer, max_results: nil, page_token: nil, role_id: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::RoleAssignments
Retrieves a paginated list of all roleAssignments.
#list_roles(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Roles
Retrieves a paginated list of all the roles in a domain.
#list_schemas(customer_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Schemas
Retrieve all schemas for a customer.
#list_tokens(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Tokens
Returns the set of tokens specified user has issued to 3rd party applications.
#list_user_aliases(user_key, event: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Aliases
List all aliases for a user.
#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Users
Retrieve either deleted users or all users in a domain (paginated).
#list_verification_codes(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::VerificationCodes
Returns the current set of valid backup verification codes for the specified user.
#make_user_admin(user_key, user_make_admin_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
change admin status of a user.
#patch_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::CalendarResource
Updates a calendar resource.
#patch_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::ChromeOsDevice
Update Chrome OS Device.
#patch_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Customer
Updates a customer.
#patch_group(group_key, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Group
Update Group.
#patch_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Member
Update membership of a user in the specified group.
#patch_notification(customer, notification_id, notification_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Notification
Updates a notification.
#patch_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::OrgUnit
Update Organization Unit.
#patch_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Role
Updates a role.
#patch_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Schema
Update schema.
#patch_user(user_key, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::User
update user.
#patch_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::UserPhoto
Add a photo for the user.
#stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Stop watching resources through this channel.
#undelete_user(user_key, user_undelete_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Undelete a deleted user.
#update_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::CalendarResource
Updates a calendar resource.
#update_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::ChromeOsDevice
Update Chrome OS Device.
#update_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Customer
Updates a customer.
#update_group(group_key, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Group
Update Group.
#update_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Member
Update membership of a user in the specified group.
#update_notification(customer, notification_id, notification_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Notification
Updates a notification.
#update_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::OrgUnit
Update Organization Unit.
#update_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Role
Updates a role.
#update_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Schema
Update schema.
#update_user(user_key, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::User
update user.
#update_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::UserPhoto
Add a photo for the user.
#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Channel
Watch for changes in users list.
#watch_user_alias(user_key, channel_object = nil, event: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Channel
Watch for changes in user aliases list.

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initialize ⇒ `DirectoryService`

Returns a new instance of DirectoryService.



52
53
54

# File 'generated/google/apis/admin_directory_v1/service.rb', line 52

def initialize
  super('https://www.googleapis.com/', 'admin/directory/v1/')
end

Instance Attribute Details

#key ⇒ `String`

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

(String) —
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



39
40
41

# File 'generated/google/apis/admin_directory_v1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ `String`

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Returns:

(String) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.



45
46
47

# File 'generated/google/apis/admin_directory_v1/service.rb', line 45

def quota_user
  @quota_user
end

#user_ip ⇒ `String`

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

(String) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.



50
51
52

# File 'generated/google/apis/admin_directory_v1/service.rb', line 50

def user_ip
  @user_ip
end

Instance Method Details

#action_chromeosdevice(customer_id, resource_id, chrome_os_device_action_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Take action on Chrome OS Device

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
resource_id (String) —
Immutable id of Chrome OS Device
chrome_os_device_action_object (Google::Apis::AdminDirectoryV1::ChromeOsDeviceAction) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 228

def action_chromeosdevice(customer_id, resource_id, chrome_os_device_action_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Take action on Mobile Device

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
resource_id (String) —
Immutable id of Mobile Device
mobile_device_action_object (Google::Apis::AdminDirectoryV1::MobileDeviceAction) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1442

def action_mobile_device(customer_id, resource_id, mobile_device_action_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#calendar_resource(customer, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::CalendarResource`

Inserts a calendar resource.

Parameters:

customer (String) —
The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
calendar_resource_object (Google::Apis::AdminDirectoryV1::CalendarResource) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::CalendarResource) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::CalendarResource)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2161

def calendar_resource(customer, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete an ASP issued by a user.

Parameters:

user_key (String) —
Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
code_id (Fixnum) —
The unique ID of the ASP to be deleted.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 83

def delete_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a calendar resource.

Parameters:

customer (String) —
The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
calendar_resource_id (String) —
The unique ID of the calendar resource to delete.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2086

def delete_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a domain of the customer.

Parameters:

customer (String) —
Immutable id of the Google Apps account.
domain_name (String) —
Name of domain to be deleted
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 711

def delete_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a Domain Alias of the customer.

Parameters:

customer (String) —
Immutable id of the Google Apps account.
domain_alias_name (String) —
Name of domain alias to be retrieved.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 561

def delete_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete Group

Parameters:

group_key (String) —
Email or immutable Id of the group
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 856

def delete_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_group_alias(group_key, group_alias, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Remove a alias for the group

Parameters:

group_key (String) —
Email or immutable Id of the group
group_alias (String) —
The alias to be removed
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1089

def delete_group_alias(group_key, group_alias, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Remove membership.

Parameters:

group_key (String) —
Email or immutable Id of the group
member_key (String) —
Email or immutable Id of the member
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1198

def delete_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_mobile_device(customer_id, resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete Mobile Device

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
resource_id (String) —
Immutable id of Mobile Device
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1480

def delete_mobile_device(customer_id, resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a notification

Parameters:

customer (String) —
The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource.
notification_id (String) —
The unique ID of the notification.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1613

def delete_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'customer/{customer}/notifications/{notificationId}', options)
  command.params['customer'] = customer unless customer.nil?
  command.params['notificationId'] = notification_id unless notification_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Remove Organization Unit

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
org_unit_path (Array<String>, String) —
Full path of the organization unit or its Id
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1815

def delete_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a role.

Parameters:

customer (String) —
Immutable ID of the Google Apps account.
role_id (String) —
Immutable ID of the role.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2487

def delete_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a role assignment.

Parameters:

customer (String) —
Immutable ID of the Google Apps account.
role_assignment_id (String) —
Immutable ID of the role assignment.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2326

def delete_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete schema

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
schema_key (String) —
Name or immutable Id of the schema
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2722

def delete_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete all access tokens issued by a user for an application.

Parameters:

user_key (String) —
Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
client_id (String) —
The Client ID of the application the token is issued to.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2952

def delete_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_user(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete user

Parameters:

user_key (String) —
Email or immutable Id of the user
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3061

def delete_user(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_alias(user_key, user_alias, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Remove a alias for the user

Parameters:

user_key (String) —
Email or immutable Id of the user
user_alias (String) —
The alias to be removed
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3473

def delete_user_alias(user_key, user_alias, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Remove photos for the user

Parameters:

user_key (String) —
Email or immutable Id of the user
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3624

def delete_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#generate_verification_code(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Generate new backup verification codes for the user.

Parameters:

user_key (String) —
Email or immutable Id of the user
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3768

def generate_verification_code(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Asp`

Get information about an ASP issued by a user.

Parameters:

user_key (String) —
Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
code_id (Fixnum) —
The unique ID of the ASP.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Asp) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Asp)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 120

def get_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::CalendarResource`

Retrieves a calendar resource.

Parameters:

customer (String) —
The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
calendar_resource_id (String) —
The unique ID of the calendar resource to retrieve.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::CalendarResource) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::CalendarResource)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2123

def get_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_chrome_os_device(customer_id, device_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::ChromeOsDevice`

Retrieve Chrome OS Device

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
device_id (String) —
Immutable id of Chrome OS Device
projection (String) (defaults to: nil) —
Restrict information returned to a set of selected fields.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::ChromeOsDevice) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::ChromeOsDevice)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 268

def get_chrome_os_device(customer_id, device_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_customer(customer_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Customer`

Retrieves a customer.

Parameters:

customer_key (String) —
Id of the customer to be retrieved
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Customer) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Customer)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 448

def get_customer(customer_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Domains`

Retrieves a domain of the customer.

Parameters:

customer (String) —
Immutable id of the Google Apps account.
domain_name (String) —
Name of domain to be retrieved
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Domains) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Domains)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 747

def get_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::DomainAlias`

Retrieves a domain alias of the customer.

Parameters:

customer (String) —
Immutable id of the Google Apps account.
domain_alias_name (String) —
Name of domain alias to be retrieved.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::DomainAlias) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::DomainAlias)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 597

def get_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Group`

Retrieve Group

Parameters:

group_key (String) —
Email or immutable Id of the group
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Group) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Group)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 889

def get_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Member`

Retrieve Group Member

Parameters:

group_key (String) —
Email or immutable Id of the group
member_key (String) —
Email or immutable Id of the member
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Member) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Member)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1234

def get_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_mobile_device(customer_id, resource_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::MobileDevice`

Retrieve Mobile Device

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
resource_id (String) —
Immutable id of Mobile Device
projection (String) (defaults to: nil) —
Restrict information returned to a set of selected fields.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::MobileDevice) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::MobileDevice)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1518

def get_mobile_device(customer_id, resource_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Notification`

Retrieves a notification.

Parameters:

customer (String) —
The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource.
notification_id (String) —
The unique ID of the notification.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Notification) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Notification)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1650

def get_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'customer/{customer}/notifications/{notificationId}', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Notification::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Notification
  command.params['customer'] = customer unless customer.nil?
  command.params['notificationId'] = notification_id unless notification_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::OrgUnit`

Retrieve Organization Unit

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
org_unit_path (Array<String>, String) —
Full path of the organization unit or its Id
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::OrgUnit) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::OrgUnit)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1851

def get_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Role`

Retrieves a role.

Parameters:

customer (String) —
Immutable ID of the Google Apps account.
role_id (String) —
Immutable ID of the role.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Role) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Role)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2523

def get_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::RoleAssignment`

Retrieve a role assignment.

Parameters:

customer (String) —
Immutable ID of the Google Apps account.
role_assignment_id (String) —
Immutable ID of the role assignment.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::RoleAssignment) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::RoleAssignment)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2362

def get_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Schema`

Retrieve schema

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
schema_key (String) —
Name or immutable Id of the schema
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Schema) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Schema)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2758

def get_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Token`

Get information about an access token issued by a user.

Parameters:

user_key (String) —
Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
client_id (String) —
The Client ID of the application the token is issued to.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Token) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Token)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2989

def get_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::User`

retrieve user

Parameters:

user_key (String) —
Email or immutable Id of the user
custom_field_mask (String) (defaults to: nil) —
Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
projection (String) (defaults to: nil) —
What subset of fields to fetch for this user.
view_type (String) (defaults to: nil) —
Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::User) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::User)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3101

def get_user(user_key, custom_field_mask: nil, projection: nil, view_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::UserPhoto`

Retrieve photo of a user

Parameters:

user_key (String) —
Email or immutable Id of the user
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::UserPhoto) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::UserPhoto)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3657

def get_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_domain(customer, domains_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Domains`

Inserts a domain of the customer.

Parameters:

customer (String) —
Immutable id of the Google Apps account.
domains_object (Google::Apis::AdminDirectoryV1::Domains) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Domains) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Domains)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 784

def insert_domain(customer, domains_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_domain_alias(customer, domain_alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::DomainAlias`

Inserts a Domain alias of the customer.

Parameters:

customer (String) —
Immutable id of the Google Apps account.
domain_alias_object (Google::Apis::AdminDirectoryV1::DomainAlias) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::DomainAlias) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::DomainAlias)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 634

def insert_domain_alias(customer, domain_alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_group(group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Group`

Create Group

Parameters:

group_object (Google::Apis::AdminDirectoryV1::Group) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Group) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Group)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 923

def insert_group(group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_group_alias(group_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Alias`

Add a alias for the group

Parameters:

group_key (String) —
Email or immutable Id of the group
alias_object (Google::Apis::AdminDirectoryV1::Alias) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Alias) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Alias)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1124

def insert_group_alias(group_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_member(group_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Member`

Add user to the specified group.

Parameters:

group_key (String) —
Email or immutable Id of the group
member_object (Google::Apis::AdminDirectoryV1::Member) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Member) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Member)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1271

def insert_member(group_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_org_unit(customer_id, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::OrgUnit`

Add Organization Unit

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
org_unit_object (Google::Apis::AdminDirectoryV1::OrgUnit) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::OrgUnit) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::OrgUnit)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1888

def insert_org_unit(customer_id, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_role(customer, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Role`

Creates a role.

Parameters:

customer (String) —
Immutable ID of the Google Apps account.
role_object (Google::Apis::AdminDirectoryV1::Role) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Role) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Role)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2560

def insert_role(customer, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_role_assignment(customer, role_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::RoleAssignment`

Creates a role assignment.

Parameters:

customer (String) —
Immutable ID of the Google Apps account.
role_assignment_object (Google::Apis::AdminDirectoryV1::RoleAssignment) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::RoleAssignment) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::RoleAssignment)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2399

def insert_role_assignment(customer, role_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_schema(customer_id, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Schema`

Create schema.

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
schema_object (Google::Apis::AdminDirectoryV1::Schema) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Schema) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Schema)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2795

def insert_schema(customer_id, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_user(user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::User`

create user.

Parameters:

user_object (Google::Apis::AdminDirectoryV1::User) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::User) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::User)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3138

def insert_user(user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_user_alias(user_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Alias`

Add a alias for the user

Parameters:

user_key (String) —
Email or immutable Id of the user
alias_object (Google::Apis::AdminDirectoryV1::Alias) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Alias) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Alias)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3508

def insert_user_alias(user_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#invalidate_verification_code(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Invalidate the current backup verification codes for the user.

Parameters:

user_key (String) —
Email or immutable Id of the user
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3801

def invalidate_verification_code(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_asps(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Asps`

List the ASPs issued by a user.

Parameters:

user_key (String) —
Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Asps) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Asps)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 157

def list_asps(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_calendar_resources(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::CalendarResources`

Retrieves a list of calendar resources for an account.

Parameters:

customer (String) —
The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
max_results (Fixnum) (defaults to: nil) —
Maximum number of results to return.
page_token (String) (defaults to: nil) —
Token to specify the next page in the list.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::CalendarResources) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::CalendarResources)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2203

def list_calendar_resources(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_chrome_os_devices(customer_id, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::ChromeOsDevices`

Retrieve all Chrome OS Devices of a customer (paginated)

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
max_results (Fixnum) (defaults to: nil) —
Maximum number of results to return. Default is 100
order_by (String) (defaults to: nil) —
Column to use for sorting results
page_token (String) (defaults to: nil) —
Token to specify next page in the list
projection (String) (defaults to: nil) —
Restrict information returned to a set of selected fields.
query (String) (defaults to: nil) —
Search string in the format given at http://support.google.com/chromeos/a/bin/ answer.py?hl=en&answer=1698333
sort_order (String) (defaults to: nil) —
Whether to return results in ascending or descending order. Only of use when orderBy is also used
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::ChromeOsDevices) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::ChromeOsDevices)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 319

def list_chrome_os_devices(customer_id, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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['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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_domain_aliases(customer, parent_domain_name: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::DomainAliases`

Lists the domain aliases of the customer.

Parameters:

customer (String) —
Immutable id of the Google Apps account.
parent_domain_name (String) (defaults to: nil) —
Name of the parent domain for which domain aliases are to be fetched.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::DomainAliases) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::DomainAliases)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 673

def list_domain_aliases(customer, parent_domain_name: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_domains(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Domains2`

Lists the domains of the customer.

Parameters:

customer (String) —
Immutable id of the Google Apps account.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Domains2) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Domains2)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 821

def list_domains(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_group_aliases(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Aliases`

List all aliases for a group

Parameters:

group_key (String) —
Email or immutable Id of the group
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Aliases) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Aliases)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1161

def list_group_aliases(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_groups(customer: nil, domain: nil, max_results: nil, page_token: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Groups`

Retrieve all groups in a domain (paginated)

Parameters:

customer (String) (defaults to: nil) —
Immutable id of the Google Apps account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.
domain (String) (defaults to: nil) —
Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.
max_results (Fixnum) (defaults to: nil) —
Maximum number of results to return. Default is 200
page_token (String) (defaults to: nil) —
Token to specify next page in the list
user_key (String) (defaults to: nil) —
Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Groups) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Groups)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 970

def list_groups(customer: nil, domain: nil, max_results: nil, page_token: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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['pageToken'] = page_token unless page_token.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_members(group_key, max_results: nil, page_token: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Members`

Retrieve all members in a group (paginated)

Parameters:

group_key (String) —
Email or immutable Id of the group
max_results (Fixnum) (defaults to: nil) —
Maximum number of results to return. Default is 200
page_token (String) (defaults to: nil) —
Token to specify next page in the list
roles (String) (defaults to: nil) —
Comma separated role values to filter list results on.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Members) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Members)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1314

def list_members(group_key, max_results: nil, page_token: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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['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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::MobileDevices`

Retrieve all Mobile Devices of a customer (paginated)

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
max_results (Fixnum) (defaults to: nil) —
Maximum number of results to return. Default is 100
order_by (String) (defaults to: nil) —
Column to use for sorting results
page_token (String) (defaults to: nil) —
Token to specify next page in the list
projection (String) (defaults to: nil) —
Restrict information returned to a set of selected fields.
query (String) (defaults to: nil) —
Search string in the format given at http://support.google.com/a/bin/answer.py? hl=en&answer=1408863#search
sort_order (String) (defaults to: nil) —
Whether to return results in ascending or descending order. Only of use when orderBy is also used
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::MobileDevices) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::MobileDevices)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1569

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_notifications(customer, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Notifications`

Retrieves a list of notifications.

Parameters:

customer (String) —
The unique ID for the customer's Google account.
language (String) (defaults to: nil) —
The ISO 639-1 code of the language notifications are returned in. The default is English (en).
max_results (Fixnum) (defaults to: nil) —
Maximum number of notifications to return per page. The default is 100.
page_token (String) (defaults to: nil) —
The token to specify the page of results to retrieve.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Notifications) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Notifications)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1693

def list_notifications(customer, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'customer/{customer}/notifications', options)
  command.response_representation = Google::Apis::AdminDirectoryV1::Notifications::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Notifications
  command.params['customer'] = customer unless customer.nil?
  command.query['language'] = language unless language.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_org_units(customer_id, org_unit_path: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::OrgUnits`

Retrieve all Organization Units

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
org_unit_path (String) (defaults to: nil) —
the URL-encoded organization unit's path or its Id
type (String) (defaults to: nil) —
Whether to return all sub-organizations or just immediate children
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::OrgUnits) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::OrgUnits)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1929

def list_org_units(customer_id, org_unit_path: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_privileges(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Privileges`

Retrieves a paginated list of all privileges for a customer.

Parameters:

customer (String) —
Immutable ID of the Google Apps account.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Privileges) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Privileges)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2048

def list_privileges(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::RoleAssignments`

Retrieves a paginated list of all roleAssignments.

Parameters:

customer (String) —
Immutable ID of the Google Apps account.
max_results (Fixnum) (defaults to: nil) —
Maximum number of results to return.
page_token (String) (defaults to: nil) —
Token to specify the next page in the list.
role_id (String) (defaults to: nil) —
Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.
user_key (String) (defaults to: nil) —
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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::RoleAssignments) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::RoleAssignments)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2446

def list_role_assignments(customer, max_results: nil, page_token: nil, role_id: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_roles(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Roles`

Retrieves a paginated list of all the roles in a domain.

Parameters:

customer (String) —
Immutable id of the Google Apps account.
max_results (Fixnum) (defaults to: nil) —
Maximum number of results to return.
page_token (String) (defaults to: nil) —
Token to specify the next page in the list.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Roles) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Roles)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2601

def list_roles(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_schemas(customer_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Schemas`

Retrieve all schemas for a customer

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Schemas) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Schemas)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2832

def list_schemas(customer_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_tokens(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Tokens`

Returns the set of tokens specified user has issued to 3rd party applications.

Parameters:

user_key (String) —
Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Tokens) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Tokens)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3026

def list_tokens(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_user_aliases(user_key, event: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Aliases`

List all aliases for a user

Parameters:

user_key (String) —
Email or immutable Id of the user
event (String) (defaults to: nil) —
Event on which subscription is intended (if subscribing)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Aliases) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Aliases)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3547

def list_user_aliases(user_key, event: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Users`

Retrieve either deleted users or all users in a domain (paginated)

Parameters:

custom_field_mask (String) (defaults to: nil) —
Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
customer (String) (defaults to: nil) —
Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
domain (String) (defaults to: nil) —
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.
event (String) (defaults to: nil) —
Event on which subscription is intended (if subscribing)
max_results (Fixnum) (defaults to: nil) —
Maximum number of results to return. Default is 100. Max allowed is 500
order_by (String) (defaults to: nil) —
Column to use for sorting results
page_token (String) (defaults to: nil) —
Token to specify next page in the list
projection (String) (defaults to: nil) —
What subset of fields to fetch for this user.
query (String) (defaults to: nil) —
Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
show_deleted (String) (defaults to: nil) —
If set to true retrieves the list of deleted users. Default is false
sort_order (String) (defaults to: nil) —
Whether to return results in ascending or descending order.
view_type (String) (defaults to: nil) —
Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Users) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Users)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3200

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_verification_codes(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::VerificationCodes`

Returns the current set of valid backup verification codes for the specified user.

Parameters:

user_key (String) —
Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::VerificationCodes) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::VerificationCodes)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3836

def list_verification_codes(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#make_user_admin(user_key, user_make_admin_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

change admin status of a user

Parameters:

user_key (String) —
Email or immutable Id of the user as admin
user_make_admin_object (Google::Apis::AdminDirectoryV1::UserMakeAdmin) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3247

def make_user_admin(user_key, user_make_admin_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::CalendarResource`

Updates a calendar resource. This method supports patch semantics.

Parameters:

customer (String) —
The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
calendar_resource_id (String) —
The unique ID of the calendar resource to update.
calendar_resource_object (Google::Apis::AdminDirectoryV1::CalendarResource) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::CalendarResource) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::CalendarResource)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2244

def patch_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::ChromeOsDevice`

Update Chrome OS Device. This method supports patch semantics.

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
device_id (String) —
Immutable id of Chrome OS Device
chrome_os_device_object (Google::Apis::AdminDirectoryV1::ChromeOsDevice) (defaults to: nil)
projection (String) (defaults to: nil) —
Restrict information returned to a set of selected fields.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::ChromeOsDevice) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::ChromeOsDevice)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 365

def patch_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Customer`

Updates a customer. This method supports patch semantics.

Parameters:

customer_key (String) —
Id of the customer to be updated
customer_object (Google::Apis::AdminDirectoryV1::Customer) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Customer) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Customer)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 484

def patch_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_group(group_key, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Group`

Update Group. This method supports patch semantics.

Parameters:

group_key (String) —
Email or immutable Id of the group. If Id, it should match with id of group object
group_object (Google::Apis::AdminDirectoryV1::Group) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Group) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Group)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1011

def patch_group(group_key, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Member`

Update membership of a user in the specified group. This method supports patch semantics.

Parameters:

group_key (String) —
Email or immutable Id of the group. If Id, it should match with id of group object
member_key (String) —
Email or immutable Id of the user. If Id, it should match with id of member object
member_object (Google::Apis::AdminDirectoryV1::Member) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Member) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Member)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1358

def patch_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_notification(customer, notification_id, notification_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Notification`

Updates a notification. This method supports patch semantics.

Parameters:

customer (String) —
The unique ID for the customer's Google account.
notification_id (String) —
The unique ID of the notification.
notification_object (Google::Apis::AdminDirectoryV1::Notification) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Notification) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Notification)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1734

def patch_notification(customer, notification_id, notification_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'customer/{customer}/notifications/{notificationId}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Notification::Representation
  command.request_object = notification_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Notification::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Notification
  command.params['customer'] = customer unless customer.nil?
  command.params['notificationId'] = notification_id unless notification_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::OrgUnit`

Update Organization Unit. This method supports patch semantics.

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
org_unit_path (Array<String>, String) —
Full path of the organization unit or its Id
org_unit_object (Google::Apis::AdminDirectoryV1::OrgUnit) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::OrgUnit) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::OrgUnit)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1969

def patch_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Role`

Updates a role. This method supports patch semantics.

Parameters:

customer (String) —
Immutable ID of the Google Apps account.
role_id (String) —
Immutable ID of the role.
role_object (Google::Apis::AdminDirectoryV1::Role) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Role) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Role)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2641

def patch_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Schema`

Update schema. This method supports patch semantics.

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
schema_key (String) —
Name or immutable Id of the schema.
schema_object (Google::Apis::AdminDirectoryV1::Schema) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Schema) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Schema)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2870

def patch_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_user(user_key, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::User`

update user. This method supports patch semantics.

Parameters:

user_key (String) —
Email or immutable Id of the user. If Id, it should match with id of user object
user_object (Google::Apis::AdminDirectoryV1::User) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::User) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::User)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3284

def patch_user(user_key, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::UserPhoto`

Add a photo for the user. This method supports patch semantics.

Parameters:

user_key (String) —
Email or immutable Id of the user
user_photo_object (Google::Apis::AdminDirectoryV1::UserPhoto) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::UserPhoto) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::UserPhoto)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3693

def patch_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Stop watching resources through this channel

Parameters:

channel_object (Google::Apis::AdminDirectoryV1::Channel) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 191

def stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#undelete_user(user_key, user_undelete_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Undelete a deleted user

Parameters:

user_key (String) —
The immutable id of the user
user_undelete_object (Google::Apis::AdminDirectoryV1::UserUndelete) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3322

def undelete_user(user_key, user_undelete_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::CalendarResource`

Updates a calendar resource.

Parameters:

customer (String) —
The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
calendar_resource_id (String) —
The unique ID of the calendar resource to update.
calendar_resource_object (Google::Apis::AdminDirectoryV1::CalendarResource) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::CalendarResource) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::CalendarResource)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2286

def update_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::ChromeOsDevice`

Update Chrome OS Device

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
device_id (String) —
Immutable id of Chrome OS Device
chrome_os_device_object (Google::Apis::AdminDirectoryV1::ChromeOsDevice) (defaults to: nil)
projection (String) (defaults to: nil) —
Restrict information returned to a set of selected fields.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::ChromeOsDevice) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::ChromeOsDevice)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 409

def update_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Customer`

Updates a customer.

Parameters:

customer_key (String) —
Id of the customer to be updated
customer_object (Google::Apis::AdminDirectoryV1::Customer) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Customer) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Customer)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 522

def update_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_group(group_key, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Group`

Update Group

Parameters:

group_key (String) —
Email or immutable Id of the group. If Id, it should match with id of group object
group_object (Google::Apis::AdminDirectoryV1::Group) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Group) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Group)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1050

def update_group(group_key, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Member`

Update membership of a user in the specified group.

Parameters:

group_key (String) —
Email or immutable Id of the group. If Id, it should match with id of group object
member_key (String) —
Email or immutable Id of the user. If Id, it should match with id of member object
member_object (Google::Apis::AdminDirectoryV1::Member) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Member) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Member)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1401

def update_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_notification(customer, notification_id, notification_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Notification`

Updates a notification.

Parameters:

customer (String) —
The unique ID for the customer's Google account.
notification_id (String) —
The unique ID of the notification.
notification_object (Google::Apis::AdminDirectoryV1::Notification) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Notification) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Notification)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 1775

def update_notification(customer, notification_id, notification_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'customer/{customer}/notifications/{notificationId}', options)
  command.request_representation = Google::Apis::AdminDirectoryV1::Notification::Representation
  command.request_object = notification_object
  command.response_representation = Google::Apis::AdminDirectoryV1::Notification::Representation
  command.response_class = Google::Apis::AdminDirectoryV1::Notification
  command.params['customer'] = customer unless customer.nil?
  command.params['notificationId'] = notification_id unless notification_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::OrgUnit`

Update Organization Unit

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
org_unit_path (Array<String>, String) —
Full path of the organization unit or its Id
org_unit_object (Google::Apis::AdminDirectoryV1::OrgUnit) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::OrgUnit) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::OrgUnit)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2010

def update_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Role`

Updates a role.

Parameters:

customer (String) —
Immutable ID of the Google Apps account.
role_id (String) —
Immutable ID of the role.
role_object (Google::Apis::AdminDirectoryV1::Role) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Role) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Role)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2682

def update_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Schema`

Update schema

Parameters:

customer_id (String) —
Immutable id of the Google Apps account
schema_key (String) —
Name or immutable Id of the schema.
schema_object (Google::Apis::AdminDirectoryV1::Schema) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Schema) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Schema)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 2911

def update_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_user(user_key, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::User`

update user

Parameters:

user_key (String) —
Email or immutable Id of the user. If Id, it should match with id of user object
user_object (Google::Apis::AdminDirectoryV1::User) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::User) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::User)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3359

def update_user(user_key, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::UserPhoto`

Add a photo for the user

Parameters:

user_key (String) —
Email or immutable Id of the user
user_photo_object (Google::Apis::AdminDirectoryV1::UserPhoto) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::UserPhoto) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::UserPhoto)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3731

def update_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Channel`

Watch for changes in users list

Parameters:

channel_object (Google::Apis::AdminDirectoryV1::Channel) (defaults to: nil)
custom_field_mask (String) (defaults to: nil) —
Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
customer (String) (defaults to: nil) —
Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
domain (String) (defaults to: nil) —
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.
event (String) (defaults to: nil) —
Event on which subscription is intended (if subscribing)
max_results (Fixnum) (defaults to: nil) —
Maximum number of results to return. Default is 100. Max allowed is 500
order_by (String) (defaults to: nil) —
Column to use for sorting results
page_token (String) (defaults to: nil) —
Token to specify next page in the list
projection (String) (defaults to: nil) —
What subset of fields to fetch for this user.
query (String) (defaults to: nil) —
Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
show_deleted (String) (defaults to: nil) —
If set to true retrieves the list of deleted users. Default is false
sort_order (String) (defaults to: nil) —
Whether to return results in ascending or descending order.
view_type (String) (defaults to: nil) —
Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Channel) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Channel)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3423

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#watch_user_alias(user_key, channel_object = nil, event: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Channel`

Watch for changes in user aliases list

Parameters:

user_key (String) —
Email or immutable Id of the user
channel_object (Google::Apis::AdminDirectoryV1::Channel) (defaults to: nil)
event (String) (defaults to: nil) —
Event on which subscription is intended (if subscribing)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
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. Overrides userIp if both are provided.
user_ip (String) (defaults to: nil) —
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AdminDirectoryV1::Channel) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AdminDirectoryV1::Channel)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/admin_directory_v1/service.rb', line 3586

def watch_user_alias(user_key, channel_object = nil, event: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Class: Google::Apis::AdminDirectoryV1::DirectoryService

Overview

Examples:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

Instance Method Summary collapse

Methods inherited from Core::BaseService

Constructor Details

#initialize ⇒ DirectoryService

Instance Attribute Details

#key ⇒ String

#quota_user ⇒ String

#user_ip ⇒ String

Instance Method Details

#action_chromeosdevice(customer_id, resource_id, chrome_os_device_action_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#action_mobile_device(customer_id, resource_id, mobile_device_action_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#calendar_resource(customer, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::CalendarResource

#delete_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_group_alias(group_key, group_alias, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_mobile_device(customer_id, resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_user(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_user_alias(user_key, user_alias, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#generate_verification_code(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#get_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Asp

#get_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::CalendarResource

#get_chrome_os_device(customer_id, device_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::ChromeOsDevice

#get_customer(customer_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Customer

#get_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Domains

#get_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::DomainAlias

#get_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Group

#get_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Member

#get_mobile_device(customer_id, resource_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::MobileDevice

#get_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Notification

#get_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::OrgUnit

#get_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Role

#get_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::RoleAssignment

#get_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Schema

#get_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Token

#get_user(user_key, custom_field_mask: nil, projection: nil, view_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::User

#get_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::UserPhoto

#insert_domain(customer, domains_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Domains

#insert_domain_alias(customer, domain_alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::DomainAlias

#insert_group(group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Group

#insert_group_alias(group_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Alias

#insert_member(group_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Member

#insert_org_unit(customer_id, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::OrgUnit

#insert_role(customer, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Role

#insert_role_assignment(customer, role_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::RoleAssignment

#insert_schema(customer_id, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Schema

#insert_user(user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::User

#insert_user_alias(user_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Alias

#invalidate_verification_code(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#list_asps(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Asps

#list_calendar_resources(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::CalendarResources

#list_chrome_os_devices(customer_id, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::ChromeOsDevices

#list_domain_aliases(customer, parent_domain_name: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::DomainAliases

#list_domains(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Domains2

#list_group_aliases(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Aliases

#list_groups(customer: nil, domain: nil, max_results: nil, page_token: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Groups

#list_members(group_key, max_results: nil, page_token: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Members

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::MobileDevices

#list_notifications(customer, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Notifications

#list_org_units(customer_id, org_unit_path: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::OrgUnits

#list_privileges(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Privileges

#list_role_assignments(customer, max_results: nil, page_token: nil, role_id: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::RoleAssignments

#list_roles(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Roles

#list_schemas(customer_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Schemas

#list_tokens(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDirectoryV1::Tokens

#initialize ⇒ `DirectoryService`

#key ⇒ `String`

#quota_user ⇒ `String`

#user_ip ⇒ `String`

#calendar_resource(customer, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::CalendarResource`

#get_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Asp`

#get_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::CalendarResource`

#get_chrome_os_device(customer_id, device_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::ChromeOsDevice`

#get_customer(customer_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Customer`

#get_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Domains`

#get_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::DomainAlias`

#get_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Group`

#get_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Member`

#get_mobile_device(customer_id, resource_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::MobileDevice`

#get_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Notification`

#get_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::OrgUnit`

#get_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Role`

#get_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::RoleAssignment`

#get_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Schema`

#get_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Token`

#get_user(user_key, custom_field_mask: nil, projection: nil, view_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::User`

#get_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::UserPhoto`

#insert_domain(customer, domains_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Domains`

#insert_domain_alias(customer, domain_alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::DomainAlias`

#insert_group(group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Group`

#insert_group_alias(group_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Alias`

#insert_member(group_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Member`

#insert_org_unit(customer_id, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::OrgUnit`

#insert_role(customer, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Role`

#insert_role_assignment(customer, role_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::RoleAssignment`

#insert_schema(customer_id, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Schema`

#insert_user(user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::User`

#insert_user_alias(user_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Alias`

#list_asps(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Asps`

#list_calendar_resources(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::CalendarResources`

#list_chrome_os_devices(customer_id, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::ChromeOsDevices`

#list_domain_aliases(customer, parent_domain_name: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::DomainAliases`

#list_domains(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Domains2`

#list_group_aliases(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Aliases`

#list_groups(customer: nil, domain: nil, max_results: nil, page_token: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Groups`

#list_members(group_key, max_results: nil, page_token: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Members`

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::MobileDevices`

#list_notifications(customer, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Notifications`

#list_org_units(customer_id, org_unit_path: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::OrgUnits`

#list_privileges(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Privileges`

#list_role_assignments(customer, max_results: nil, page_token: nil, role_id: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::RoleAssignments`

#list_roles(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Roles`

#list_schemas(customer_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Schemas`

#list_tokens(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Tokens`

#list_user_aliases(user_key, event: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Aliases`

#list_verification_codes(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::VerificationCodes`

#patch_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::CalendarResource`

#patch_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::ChromeOsDevice`

#patch_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Customer`

#patch_group(group_key, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Group`

#patch_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Member`

#patch_notification(customer, notification_id, notification_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Notification`

#patch_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::OrgUnit`

#patch_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Role`

#patch_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Schema`

#patch_user(user_key, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::User`

#patch_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::UserPhoto`

#update_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::CalendarResource`

#update_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::ChromeOsDevice`

#update_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Customer`

#update_group(group_key, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Group`

#update_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Member`

#update_notification(customer, notification_id, notification_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Notification`

#update_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::OrgUnit`

#update_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Role`

#update_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Schema`

#update_user(user_key, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::User`

#update_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::UserPhoto`

#watch_user_alias(user_key, channel_object = nil, event: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AdminDirectoryV1::Channel`