API Reference google_api_admin v0.25.2
Modules
API client metadata for GoogleApi.Admin.Datatransfer_v1.
API calls for all endpoints tagged Applications
.
API calls for all endpoints tagged Transfers
.
Handle Tesla connections for GoogleApi.Admin.Datatransfer_v1.
Applications resources represent applications installed on the domain that support transferring ownership of user data.
Template to map fields of ApplicationDataTransfer resource.
Template for application transfer parameters.
Template for a collection of Applications.
A Transfer resource represents the transfer of the ownership of user data between users.
Template for a collection of DataTransfer resources.
API client metadata for GoogleApi.Admin.Directory_v1.
API calls for all endpoints tagged Asps
.
API calls for all endpoints tagged Channels
.
API calls for all endpoints tagged Chromeosdevices
.
API calls for all endpoints tagged Customer
.
API calls for all endpoints tagged Customers
.
API calls for all endpoints tagged DomainAliases
.
API calls for all endpoints tagged Domains
.
API calls for all endpoints tagged Groups
.
API calls for all endpoints tagged Members
.
API calls for all endpoints tagged Mobiledevices
.
API calls for all endpoints tagged Orgunits
.
API calls for all endpoints tagged Privileges
.
API calls for all endpoints tagged Resources
.
API calls for all endpoints tagged RoleAssignments
.
API calls for all endpoints tagged Roles
.
API calls for all endpoints tagged Schemas
.
API calls for all endpoints tagged Tokens
.
API calls for all endpoints tagged TwoStepVerification
.
API calls for all endpoints tagged Users
.
API calls for all endpoints tagged VerificationCodes
.
Handle Tesla connections for GoogleApi.Admin.Directory_v1.
JSON template for Alias object in Directory API.
JSON response template to list aliases in Directory API.
The template that returns individual ASP (Access Code) data.
Attributes
-
etag
(type:String.t
, default:nil
) - ETag of the resource. -
items
(type:list(GoogleApi.Admin.Directory_v1.Model.Asp.t)
, default:nil
) - A list of ASP resources. -
kind
(type:String.t
, default:admin#directory#aspList
) - The type of the API resource. This is always admin#directory#aspList.
Public API: Resources.buildings
Public API: Resources.buildings
Public API: Resources.buildings
Public API: Resources.buildings
Public API: Resources.calendars
Public API: Resources.calendars
An notification channel used to watch for resource changes.
Attributes
-
systemRamTotal
(type:String.t
, default:nil
) - Total RAM on the device [in bytes] (Read-only) -
macAddress
(type:String.t
, default:nil
) - Chromebook Mac Address on wifi network interface (Read-only) -
annotatedLocation
(type:String.t
, default:nil
) - Address or location of the device as noted by the administrator -
deviceFiles
(type:list(GoogleApi.Admin.Directory_v1.Model.ChromeOsDeviceDeviceFiles.t)
, default:nil
) - List of device files to download (Read-only) -
etag
(type:String.t
, default:nil
) - ETag of the resource. -
platformVersion
(type:String.t
, default:nil
) - Chromebook platform version (Read-only) -
osVersion
(type:String.t
, default:nil
) - Chromebook Os Version (Read-only) -
orgUnitPath
(type:String.t
, default:nil
) - OrgUnit of the device -
firmwareVersion
(type:String.t
, default:nil
) - Chromebook firmware version (Read-only) -
annotatedUser
(type:String.t
, default:nil
) - User of the device -
kind
(type:String.t
, default:admin#directory#chromeosdevice
) - Kind of resource this is. -
recentUsers
(type:list(GoogleApi.Admin.Directory_v1.Model.ChromeOsDeviceRecentUsers.t)
, default:nil
) - List of recent device users, in descending order by last login time (Read-only) -
supportEndDate
(type:DateTime.t
, default:nil
) - Final date the device will be supported (Read-only) -
lastSync
(type:DateTime.t
, default:nil
) - Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) -
deviceId
(type:String.t
, default:nil
) - Unique identifier of Chrome OS Device (Read-only) -
manufactureDate
(type:String.t
, default:nil
) - (Read-only) The date the device was manufactured in yyyy-mm-dd format. -
status
(type:String.t
, default:nil
) - status of the device (Read-only) -
orderNumber
(type:String.t
, default:nil
) - Chromebook order number (Read-only) -
model
(type:String.t
, default:nil
) - Chromebook Model (Read-only) -
ethernetMacAddress0
(type:String.t
, default:nil
) - (Read-only) MAC address used by the Chromebook’s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices. -
serialNumber
(type:String.t
, default:nil
) - Chromebook serial number (Read-only) -
meid
(type:String.t
, default:nil
) - Contains either the Mobile Equipment identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in the Chromebook (Read-only) -
tpmVersionInfo
(type:GoogleApi.Admin.Directory_v1.Model.ChromeOsDeviceTpmVersionInfo.t
, default:nil
) - Trusted Platform Module (TPM) (Read-only) -
activeTimeRanges
(type:list(GoogleApi.Admin.Directory_v1.Model.ChromeOsDeviceActiveTimeRanges.t)
, default:nil
) - List of active time ranges (Read-only) -
bootMode
(type:String.t
, default:nil
) - Chromebook boot mode (Read-only) -
ethernetMacAddress
(type:String.t
, default:nil
) - Chromebook Mac Address on ethernet network interface (Read-only) -
lastEnrollmentTime
(type:DateTime.t
, default:nil
) - Date and time the device was last enrolled (Read-only) -
diskVolumeReports
(type:list(GoogleApi.Admin.Directory_v1.Model.ChromeOsDeviceDiskVolumeReports.t)
, default:nil
) - Reports of disk space and other info about mounted/connected volumes. -
systemRamFreeReports
(type:list(GoogleApi.Admin.Directory_v1.Model.ChromeOsDeviceSystemRamFreeReports.t)
, default:nil
) - Reports of amounts of available RAM memory (Read-only) -
annotatedAssetId
(type:String.t
, default:nil
) - AssetId specified during enrollment or through later annotation -
cpuStatusReports
(type:list(GoogleApi.Admin.Directory_v1.Model.ChromeOsDeviceCpuStatusReports.t)
, default:nil
) - Reports of CPU utilization and temperature (Read-only) -
dockMacAddress
(type:String.t
, default:nil
) - (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices. -
autoUpdateExpiration
(type:String.t
, default:nil
) - (Read-only) The timestamp after which the device will stop receiving Chrome updates or support -
notes
(type:String.t
, default:nil
) - Notes added by the administrator -
willAutoRenew
(type:boolean()
, default:nil
) - Will Chromebook auto renew after support end date (Read-only) -
lastKnownNetwork
(type:list(GoogleApi.Admin.Directory_v1.Model.ChromeOsDeviceLastKnownNetwork.t)
, default:nil
) - Contains last known network (Read-only)
Attributes
-
cpuTemperatureInfo
(type:list(GoogleApi.Admin.Directory_v1.Model.ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo.t)
, default:nil
) - List of CPU temperature samples. -
cpuUtilizationPercentageInfo
(type:list(integer())
, default:nil
) - -
reportTime
(type:DateTime.t
, default:nil
) - Date and time the report was received.
Information for an ip address.
Trusted Platform Module (TPM) (Read-only)
Attributes
-
chromeosdevices
(type:list(GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice.t)
, default:nil
) - List of Chrome OS Device objects. -
etag
(type:String.t
, default:nil
) - ETag of the resource. -
kind
(type:String.t
, default:admin#directory#chromeosdevices
) - Kind of resource this is. -
nextPageToken
(type:String.t
, default:nil
) - Token used to access next page of this result.
Attributes
-
alternateEmail
(type:String.t
, default:nil
) - The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain -
customerCreationTime
(type:DateTime.t
, default:nil
) - The customer's creation time (Readonly) -
customerDomain
(type:String.t
, default:nil
) - The customer's primary domain name string. Do not include the www prefix when creating a new customer. -
etag
(type:String.t
, default:nil
) - ETag of the resource. -
id
(type:String.t
, default:nil
) - The unique ID for the customer's G Suite account. (Readonly) -
kind
(type:String.t
, default:admin#directory#customer
) - Identifies the resource as a customer. Value: admin#directory#customer -
language
(type:String.t
, default:nil
) - The customer's ISO 639-2 language code. The default value is en-US -
phoneNumber
(type:String.t
, default:nil
) - The customer's contact phone number in E.164 format. -
postalAddress
(type:GoogleApi.Admin.Directory_v1.Model.CustomerPostalAddress.t
, default:nil
) - The customer's postal address information.
Attributes
-
addressLine1
(type:String.t
, default:nil
) - A customer's physical address. The address can be composed of one to three lines. -
addressLine2
(type:String.t
, default:nil
) - Address line 2 of the address. -
addressLine3
(type:String.t
, default:nil
) - Address line 3 of the address. -
contactName
(type:String.t
, default:nil
) - The customer contact's name. -
countryCode
(type:String.t
, default:nil
) - This is a required property. For countryCode information see the ISO 3166 country code elements. -
locality
(type:String.t
, default:nil
) - Name of the locality. An example of a locality value is the city of San Francisco. -
organizationName
(type:String.t
, default:nil
) - The company or company division name. -
postalCode
(type:String.t
, default:nil
) - The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element. -
region
(type:String.t
, default:nil
) - Name of the region. An example of a region value is NY for the state of New York.
Information regarding a command that was issued to a device.
The result of executing a command.
A request for issuing a command.
A response for issuing a command.
Attributes
-
creationTime
(type:String.t
, default:nil
) - The creation time of the domain alias. (Read-only). -
domainAliasName
(type:String.t
, default:nil
) - The domain alias name. -
etag
(type:String.t
, default:nil
) - ETag of the resource. -
kind
(type:String.t
, default:admin#directory#domainAlias
) - Kind of resource this is. -
parentDomainName
(type:String.t
, default:nil
) - The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer. -
verified
(type:boolean()
, default:nil
) - Indicates the verification state of a domain alias. (Read-only)
Attributes
-
creationTime
(type:String.t
, default:nil
) - Creation time of the domain. (Read-only). -
domainAliases
(type:list(GoogleApi.Admin.Directory_v1.Model.DomainAlias.t)
, default:nil
) - List of domain alias objects. (Read-only) -
domainName
(type:String.t
, default:nil
) - The domain name of the customer. -
etag
(type:String.t
, default:nil
) - ETag of the resource. -
isPrimary
(type:boolean()
, default:nil
) - Indicates if the domain is a primary domain (Read-only). -
kind
(type:String.t
, default:admin#directory#domain
) - Kind of resource this is. -
verified
(type:boolean()
, default:nil
) - Indicates the verification state of a domain. (Read-only).
JSON template for Feature object in Directory API.
JSON template for a feature instance.
Public API: Resources.features
Attributes
-
adminCreated
(type:boolean()
, default:nil
) - Is the group created by admin (Read-only) * -
aliases
(type:list(String.t)
, default:nil
) - List of aliases (Read-only) -
description
(type:String.t
, default:nil
) - Description of the group -
directMembersCount
(type:String.t
, default:nil
) - Group direct members count -
email
(type:String.t
, default:nil
) - Email of Group -
etag
(type:String.t
, default:nil
) - ETag of the resource. -
id
(type:String.t
, default:nil
) - Unique identifier of Group (Read-only) -
kind
(type:String.t
, default:admin#directory#group
) - Kind of resource this is. -
name
(type:String.t
, default:nil
) - Group name -
nonEditableAliases
(type:list(String.t)
, default:nil
) - List of non editable aliases (Read-only)
Attributes
-
etag
(type:String.t
, default:nil
) - ETag of the resource. -
groups
(type:list(GoogleApi.Admin.Directory_v1.Model.Group.t)
, default:nil
) - List of group objects. -
kind
(type:String.t
, default:admin#directory#groups
) - Kind of resource this is. -
nextPageToken
(type:String.t
, default:nil
) - Token used to access next page of this result.
Attributes
-
delivery_settings
(type:String.t
, default:nil
) - Delivery settings of member -
email
(type:String.t
, default:nil
) - Email of member (Read-only) -
etag
(type:String.t
, default:nil
) - ETag of the resource. -
id
(type:String.t
, default:nil
) - Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey. -
kind
(type:String.t
, default:admin#directory#member
) - Kind of resource this is. -
role
(type:String.t
, default:nil
) - Role of member -
status
(type:String.t
, default:nil
) - Status of member (Immutable) -
type
(type:String.t
, default:nil
) - Type of member (Immutable)
Attributes
-
etag
(type:String.t
, default:nil
) - ETag of the resource. -
kind
(type:String.t
, default:admin#directory#members
) - Kind of resource this is. -
members
(type:list(GoogleApi.Admin.Directory_v1.Model.Member.t)
, default:nil
) - List of member objects. -
nextPageToken
(type:String.t
, default:nil
) - Token used to access next page of this result.
JSON template for Has Member response in Directory API.
Attributes
-
firstSync
(type:DateTime.t
, default:nil
) - Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only) -
hardware
(type:String.t
, default:nil
) - Mobile Device Hardware (Read-only) -
etag
(type:String.t
, default:nil
) - ETag of the resource. -
securityPatchLevel
(type:String.t
, default:nil
) - Mobile Device Security patch level (Read-only) -
defaultLanguage
(type:String.t
, default:nil
) - The default locale used on the Mobile Device (Read-only) -
devicePasswordStatus
(type:String.t
, default:nil
) - DevicePasswordStatus (Read-only) -
userAgent
(type:String.t
, default:nil
) - Mobile Device user agent -
deviceCompromisedStatus
(type:String.t
, default:nil
) - Mobile Device compromised status (Read-only) -
supportsWorkProfile
(type:boolean()
, default:nil
) - Work profile supported on device (Read-only) -
privilege
(type:String.t
, default:nil
) - DMAgentPermission (Read-only) -
managedAccountIsOnOwnerProfile
(type:boolean()
, default:nil
) - Boolean indicating if this account is on owner/primary profile or not (Read-only) -
email
(type:list(String.t)
, default:nil
) - List of owner user's email addresses (Read-only) -
os
(type:String.t
, default:nil
) - Name of the mobile operating system -
releaseVersion
(type:String.t
, default:nil
) - Mobile Device release version version (Read-only) -
encryptionStatus
(type:String.t
, default:nil
) - Mobile Device Encryption Status (Read-only) -
networkOperator
(type:String.t
, default:nil
) - Mobile Device mobile or network operator (if available) (Read-only) -
bootloaderVersion
(type:String.t
, default:nil
) - Mobile Device Bootloader version (Read-only) -
imei
(type:String.t
, default:nil
) - Mobile Device IMEI number (Read-only) -
kind
(type:String.t
, default:admin#directory#mobiledevice
) - Kind of resource this is. -
lastSync
(type:DateTime.t
, default:nil
) - Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) -
unknownSourcesStatus
(type:boolean()
, default:nil
) - Unknown sources enabled or disabled on device (Read-only) -
resourceId
(type:String.t
, default:nil
) - Unique identifier of Mobile Device (Read-only) -
name
(type:list(String.t)
, default:nil
) - List of owner user's names (Read-only) -
deviceId
(type:String.t
, default:nil
) - Mobile Device serial number (Read-only) -
buildNumber
(type:String.t
, default:nil
) - Mobile Device Build number (Read-only) -
status
(type:String.t
, default:nil
) - Status of the device (Read-only) -
manufacturer
(type:String.t
, default:nil
) - Mobile Device manufacturer (Read-only) -
model
(type:String.t
, default:nil
) - Name of the model of the device -
serialNumber
(type:String.t
, default:nil
) - Mobile Device SSN or Serial Number (Read-only) -
meid
(type:String.t
, default:nil
) - Mobile Device MEID number (Read-only) -
developerOptionsStatus
(type:boolean()
, default:nil
) - Developer options enabled or disabled on device (Read-only) -
brand
(type:String.t
, default:nil
) - Mobile Device Brand (Read-only) -
type
(type:String.t
, default:nil
) - The type of device (Read-only) -
kernelVersion
(type:String.t
, default:nil
) - Mobile Device Kernel version (Read-only) -
basebandVersion
(type:String.t
, default:nil
) - Mobile Device Baseband version (Read-only) -
hardwareId
(type:String.t
, default:nil
) - Mobile Device Hardware Id (Read-only) -
adbStatus
(type:boolean()
, default:nil
) - Adb (USB debugging) enabled or disabled on device (Read-only) -
wifiMacAddress
(type:String.t
, default:nil
) - Mobile Device WiFi MAC address (Read-only) -
applications
(type:list(GoogleApi.Admin.Directory_v1.Model.MobileDeviceApplications.t)
, default:nil
) - List of applications installed on Mobile Device -
otherAccountsInfo
(type:list(String.t)
, default:nil
) - List of accounts added on device (Read-only)
Attributes
-
displayName
(type:String.t
, default:nil
) - Display name of application -
packageName
(type:String.t
, default:nil
) - Package name of application -
permission
(type:list(String.t)
, default:nil
) - List of Permissions for application -
versionCode
(type:integer()
, default:nil
) - Version code of application -
versionName
(type:String.t
, default:nil
) - Version name of application
Attributes
-
etag
(type:String.t
, default:nil
) - ETag of the resource. -
kind
(type:String.t
, default:admin#directory#mobiledevices
) - Kind of resource this is. -
mobiledevices
(type:list(GoogleApi.Admin.Directory_v1.Model.MobileDevice.t)
, default:nil
) - List of Mobile Device objects. -
nextPageToken
(type:String.t
, default:nil
) - Token used to access next page of this result.
JSON template for Org Unit resource in Directory API.
JSON response template for List Organization Units operation in Directory API.
Attributes
-
childPrivileges
(type:list(GoogleApi.Admin.Directory_v1.Model.Privilege.t)
, default:nil
) - A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege. -
etag
(type:String.t
, default:nil
) - ETag of the resource. -
isOuScopable
(type:boolean()
, default:nil
) - If the privilege can be restricted to an organization unit. -
kind
(type:String.t
, default:admin#directory#privilege
) - The type of the API resource. This is always admin#directory#privilege. -
privilegeName
(type:String.t
, default:nil
) - The name of the privilege. -
serviceId
(type:String.t
, default:nil
) - The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list(). -
serviceName
(type:String.t
, default:nil
) - The name of the service this privilege is for.
Attributes
-
etag
(type:String.t
, default:nil
) - ETag of the resource. -
items
(type:list(GoogleApi.Admin.Directory_v1.Model.Privilege.t)
, default:nil
) - A list of Privilege resources. -
kind
(type:String.t
, default:admin#directory#privileges
) - The type of the API resource. This is always admin#directory#privileges.
Attributes
-
etag
(type:String.t
, default:nil
) - ETag of the resource. -
isSuperAdminRole
(type:boolean()
, default:nil
) - Returns true if the role is a super admin role. -
isSystemRole
(type:boolean()
, default:nil
) - Returns true if this is a pre-defined system role. -
kind
(type:String.t
, default:admin#directory#role
) - The type of the API resource. This is always admin#directory#role. -
roleDescription
(type:String.t
, default:nil
) - A short description of the role. -
roleId
(type:String.t
, default:nil
) - ID of the role. -
roleName
(type:String.t
, default:nil
) - Name of the role. -
rolePrivileges
(type:list(GoogleApi.Admin.Directory_v1.Model.RoleRolePrivileges.t)
, default:nil
) - The set of privileges that are granted to this role.
Attributes
-
assignedTo
(type:String.t
, default:nil
) - The unique ID of the user this role is assigned to. -
etag
(type:String.t
, default:nil
) - ETag of the resource. -
kind
(type:String.t
, default:admin#directory#roleAssignment
) - The type of the API resource. This is always admin#directory#roleAssignment. -
orgUnitId
(type:String.t
, default:nil
) - If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to. -
roleAssignmentId
(type:String.t
, default:nil
) - ID of this roleAssignment. -
roleId
(type:String.t
, default:nil
) - The ID of the role that is assigned. -
scopeType
(type:String.t
, default:nil
) - The scope in which this role is assigned. Possible values are: - CUSTOMER - ORG_UNIT
Attributes
-
etag
(type:String.t
, default:nil
) - ETag of the resource. -
items
(type:list(GoogleApi.Admin.Directory_v1.Model.RoleAssignment.t)
, default:nil
) - A list of RoleAssignment resources. -
kind
(type:String.t
, default:admin#directory#roleAssignments
) - The type of the API resource. This is always admin#directory#roleAssignments . -
nextPageToken
(type:String.t
, default:nil
) -
Attributes
-
etag
(type:String.t
, default:nil
) - ETag of the resource. -
items
(type:list(GoogleApi.Admin.Directory_v1.Model.Role.t)
, default:nil
) - A list of Role resources. -
kind
(type:String.t
, default:admin#directory#roles
) - The type of the API resource. This is always admin#directory#roles. -
nextPageToken
(type:String.t
, default:nil
) -
JSON template for Schema resource in Directory API.
JSON template for FieldSpec resource for Schemas in Directory API.
Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
JSON response template for List Schema operation in Directory API.
JSON template for token resource in Directory API.
JSON response template for List tokens operation in Directory API.
Attributes
-
ims
(type:any()
, default:nil
) - User's Instant Messenger -
posixAccounts
(type:any()
, default:nil
) - The POSIX accounts of User -
etag
(type:String.t
, default:nil
) - Output only. ETag of the resource. -
orgUnitPath
(type:String.t
, default:nil
) - OrgUnit of User -
suspensionReason
(type:String.t
, default:nil
) - Output only. Suspension reason if user is suspended (Read-only) -
agreedToTerms
(type:boolean()
, default:nil
) - Output only. Indicates if user has agreed to terms (Read-only) -
customSchemas
(type:%{optional(String.t) => GoogleApi.Admin.Directory_v1.Model.UserCustomProperties.t}
, default:nil
) - Custom fields of the user. -
externalIds
(type:any()
, default:nil
) - The external Ids of User * -
gender
(type:any()
, default:nil
) - Gender of User -
recoveryPhone
(type:String.t
, default:nil
) - Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212. -
deletionTime
(type:DateTime.t
, default:nil
) - -
keywords
(type:any()
, default:nil
) - Keywords of User -
isEnrolledIn2Sv
(type:boolean()
, default:nil
) - Output only. Is enrolled in 2-step verification (Read-only) -
includeInGlobalAddressList
(type:boolean()
, default:nil
) - Boolean indicating if user is included in Global Address List -
addresses
(type:any()
, default:nil
) - Addresses of User -
kind
(type:String.t
, default:admin#directory#user
) - Output only. Kind of resource this is. -
sshPublicKeys
(type:any()
, default:nil
) - The SSH public keys of User -
languages
(type:any()
, default:nil
) - Languages of User -
password
(type:String.t
, default:nil
) - User's password -
thumbnailPhotoEtag
(type:String.t
, default:nil
) - Output only. ETag of the user's photo (Read-only) -
hashFunction
(type:String.t
, default:nil
) - Hash function name for password. Supported are MD5, SHA-1 and crypt -
name
(type:GoogleApi.Admin.Directory_v1.Model.UserName.t
, default:nil
) - User's name -
suspended
(type:boolean()
, default:nil
) - Indicates if user is suspended. -
lastLoginTime
(type:DateTime.t
, default:nil
) - User's last login time. (Read-only) -
relations
(type:any()
, default:nil
) - The Relations of User * -
recoveryEmail
(type:String.t
, default:nil
) - Recovery email of the user. -
websites
(type:any()
, default:nil
) - Websites of User -
primaryEmail
(type:String.t
, default:nil
) - username of User -
ipWhitelisted
(type:boolean()
, default:nil
) - Boolean indicating if ip is whitelisted -
creationTime
(type:DateTime.t
, default:nil
) - User's G Suite account creation time. (Read-only) -
customerId
(type:String.t
, default:nil
) - Output only. CustomerId of User (Read-only) -
archived
(type:boolean()
, default:nil
) - Indicates if user is archived. -
isDelegatedAdmin
(type:boolean()
, default:nil
) - Output only. Boolean indicating if the user is delegated admin (Read-only) -
locations
(type:any()
, default:nil
) - Locations of User -
nonEditableAliases
(type:list(String.t)
, default:nil
) - Output only. List of non editable aliases (Read-only) -
emails
(type:any()
, default:nil
) - Emails of User -
isAdmin
(type:boolean()
, default:nil
) - Output only. Boolean indicating if the user is admin (Read-only) -
aliases
(type:list(String.t)
, default:nil
) - Output only. List of aliases (Read-only) -
id
(type:String.t
, default:nil
) - Unique identifier of User (Read-only) -
isEnforcedIn2Sv
(type:boolean()
, default:nil
) - Output only. Is 2-step verification enforced (Read-only) -
thumbnailPhotoUrl
(type:String.t
, default:nil
) - Output only. Photo Url of the user (Read-only) -
phones
(type:any()
, default:nil
) - Phone numbers of User -
notes
(type:any()
, default:nil
) - Notes of User -
changePasswordAtNextLogin
(type:boolean()
, default:nil
) - Boolean indicating if the user should change password in next login -
isMailboxSetup
(type:boolean()
, default:nil
) - Output only. Is mailbox setup (Read-only) -
organizations
(type:any()
, default:nil
) - Organizations of User
JSON template for About (notes) of a user in Directory API.
JSON template for address.
JSON template for a set of custom properties (i.e. all fields in a particular schema)
JSON template for an email.
JSON template for an externalId entry.
Attributes
-
addressMeAs
(type:String.t
, default:nil
) - AddressMeAs. A human-readable string containing the proper way to refer to the profile owner by humans for example he/him/his or they/them/their. -
customGender
(type:String.t
, default:nil
) - Custom gender. -
type
(type:String.t
, default:nil
) - Gender.
JSON template for instant messenger of an user.
JSON template for a keyword entry.
JSON template for a language entry.
JSON template for a location entry.
JSON template for an organization entry.
JSON template for a phone entry.
Attributes
-
etag
(type:String.t
, default:nil
) - ETag of the resource. -
height
(type:integer()
, default:nil
) - Height in pixels of the photo -
id
(type:String.t
, default:nil
) - Unique identifier of User (Read-only) -
kind
(type:String.t
, default:admin#directory#user#photo
) - Kind of resource this is. -
mimeType
(type:String.t
, default:nil
) - Mime Type of the photo -
photoData
(type:String.t
, default:nil
) - Base64 encoded photo data -
primaryEmail
(type:String.t
, default:nil
) - Primary email of User (Read-only) -
width
(type:integer()
, default:nil
) - Width in pixels of the photo
JSON template for a POSIX account entry.
JSON template for a relation entry.
JSON template for a POSIX account entry.
JSON template for a website entry.
Attributes
-
etag
(type:String.t
, default:nil
) - ETag of the resource. -
kind
(type:String.t
, default:admin#directory#users
) - Kind of resource this is. -
nextPageToken
(type:String.t
, default:nil
) - Token used to access next page of this result. -
trigger_event
(type:String.t
, default:nil
) - Event that triggered this response (only used in case of Push Response) -
users
(type:list(GoogleApi.Admin.Directory_v1.Model.User.t)
, default:nil
) - List of user objects.
JSON template for verification codes in Directory API.
JSON response template for List verification codes operation in Directory API.
API client metadata for GoogleApi.Admin.Reports_v1.
API calls for all endpoints tagged Activities
.
API calls for all endpoints tagged Channels
.
API calls for all endpoints tagged CustomerUsageReports
.
API calls for all endpoints tagged EntityUsageReports
.
API calls for all endpoints tagged UserUsageReport
.
Handle Tesla connections for GoogleApi.Admin.Reports_v1.
JSON template for a collection of activities.
JSON template for the activity resource.
User doing the action.
Attributes
-
name
(type:String.t
, default:nil
) - Name of the event. This is the specific name of the activity reported by the API. And each eventName is related to a specific G Suite service or feature which the API organizes into types of events. For eventName request parameters in general: - If no eventName is given, the report returns all possible instances of an eventName. - When you request an eventName, the API's response returns all activities which contain that eventName. It is possible that the returned activities will have other eventName properties in addition to the one requested. For more information about eventName properties, see the list of event names for various applications above in applicationName. -
parameters
(type:list(GoogleApi.Admin.Reports_v1.Model.ActivityEventsParameters.t)
, default:nil
) - Parameter value pairs for various applications. For more information about eventName parameters, see the list of event names for various applications above in applicationName. -
type
(type:String.t
, default:nil
) - Type of event. The G Suite service or feature that an administrator changes is identified in the type property which identifies an event using the eventName property. For a full list of the API's type categories, see the list of event names for various applications above in applicationName.
Attributes
-
boolValue
(type:boolean()
, default:nil
) - Boolean value of the parameter. -
intValue
(type:String.t
, default:nil
) - Integer value of the parameter. -
messageValue
(type:GoogleApi.Admin.Reports_v1.Model.ActivityEventsParametersMessageValue.t
, default:nil
) - Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address parameter may have a value as [{parameter: [{name: city, value: abc}]}] -
multiIntValue
(type:list(String.t)
, default:nil
) - Integer values of the parameter. -
multiMessageValue
(type:list(GoogleApi.Admin.Reports_v1.Model.ActivityEventsParametersMultiMessageValue.t)
, default:nil
) - List of messageValue objects. -
multiValue
(type:list(String.t)
, default:nil
) - String values of the parameter. -
name
(type:String.t
, default:nil
) - The name of the parameter. -
value
(type:String.t
, default:nil
) - String value of the parameter.
Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address parameter may have a value as [{parameter: [{name: city, value: abc}]}]
Unique identifier for each activity record.
A notification channel used to watch for resource changes.
JSON template for a parameter used in various reports.
JSON template for a usage report.
Output only. Information about the type of the item.
Attributes
-
boolValue
(type:boolean()
, default:nil
) - Output only. Boolean value of the parameter. -
datetimeValue
(type:DateTime.t
, default:nil
) - The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z. -
intValue
(type:String.t
, default:nil
) - Output only. Integer value of the parameter. -
msgValue
(type:list(map())
, default:nil
) - Output only. Nested message value of the parameter. -
name
(type:String.t
, default:nil
) - Name of the parameter. -
stringValue
(type:String.t
, default:nil
) - Output only. String value of the parameter.
Attributes
-
etag
(type:String.t
, default:nil
) - ETag of the resource. -
kind
(type:String.t
, default:admin#reports#usageReports
) - The type of API resource. For a usage report, the value is admin#reports#usageReports. -
nextPageToken
(type:String.t
, default:nil
) - Token to specify next page. A report with multiple pages has a nextPageToken property in the response. For your follow-on requests getting all of the report's pages, enter the nextPageToken value in the pageToken query string. -
usageReports
(type:list(GoogleApi.Admin.Reports_v1.Model.UsageReport.t)
, default:nil
) - Various application parameter records. -
warnings
(type:list(GoogleApi.Admin.Reports_v1.Model.UsageReportsWarnings.t)
, default:nil
) - Warnings, if any.
Attributes
-
code
(type:String.t
, default:nil
) - Machine readable code or warning type. The warning code value is 200. -
data
(type:list(GoogleApi.Admin.Reports_v1.Model.UsageReportsWarningsData.t)
, default:nil
) - Key-value pairs to give detailed information on the warning. -
message
(type:String.t
, default:nil
) - The human readable messages for a warning are: - Data is not available warning - Sorry, data for date yyyy-mm-dd for application "application name" is not available. - Partial data is available warning - Data for date yyyy-mm-dd for application "application name" is not available right now, please try again after a few hours.