chromeosdevices

Overview

Name	chromeosdevices
Type	Resource
Id	googleadmin.directory.chromeosdevices

Fields

Name	Datatype	Description
activeTimeRanges	array	A list of active time ranges (Read-only).
annotatedAssetId	string	The asset identifier as noted by an administrator or specified during enrollment.
annotatedLocation	string	The address or location of the device as noted by the administrator. Maximum length is 200 characters. Empty values are allowed.
annotatedUser	string	The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
autoUpdateExpiration	string	(Read-only) The timestamp after which the device will stop receiving Chrome updates or support
bootMode	string	The boot mode for the device. The possible values are: Verified: The device is running a valid version of the Chrome OS. Dev: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the Chromebook developer information.
cpuInfo	array	Information regarding CPU specs in the device.
cpuStatusReports	array	Reports of CPU utilization and temperature (Read-only)
deprovisionReason	string	(Read-only) Deprovision reason.
deviceFiles	array	A list of device files to download (Read-only)
deviceId	string	The unique ID of the Chrome device.
diskVolumeReports	array	Reports of disk space and other info about mounted/connected volumes.
dockMacAddress	string	(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.
etag	string	ETag of the resource.
ethernetMacAddress	string	The device's MAC address on the ethernet network interface.
ethernetMacAddress0	string	(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.
firmwareVersion	string	The Chrome device's firmware version.
firstEnrollmentTime	string	Date and time for the first time the device was enrolled.
kind	string	The type of resource. For the Chromeosdevices resource, the value is admin#directory#chromeosdevice.
lastDeprovisionTimestamp	string	(Read-only) Date and time for the last deprovision of the device.
lastEnrollmentTime	string	Date and time the device was last enrolled (Read-only)
lastKnownNetwork	array	Contains last known network (Read-only)
lastSync	string	Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
macAddress	string	The device's wireless MAC address. If the device does not have this information, it is not included in the response.
manufactureDate	string	(Read-only) The date the device was manufactured in yyyy-mm-dd format.
meid	string	The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the Developer's Guide.
model	string	The device's model information. If the device does not have this information, this property is not included in the response.
notes	string	Notes about this device added by the administrator. This property can be searched with the list method's query parameter. Maximum length is 500 characters. Empty values are allowed.
orderNumber	string	The device's order number. Only devices directly purchased from Google have an order number.
orgUnitId	string	The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be updated using the API. For more information about how to create an organizational structure for your device, see the administration help center.
orgUnitPath	string	The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, /. This property can be updated using the API. For more information about how to create an organizational structure for your device, see the administration help center.
osUpdateStatus	object	Contains information regarding the current OS update status.
osVersion	string	The Chrome device's operating system version.
platformVersion	string	The Chrome device's platform version.
recentUsers	array	A list of recent device users, in descending order, by last login time.
screenshotFiles	array	A list of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
serialNumber	string	The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's Serial Number in the Chrome OS Devices tab.
status	string	The status of the device.
supportEndDate	string	Final date the device will be supported (Read-only)
systemRamFreeReports	array	Reports of amounts of available RAM memory (Read-only)
systemRamTotal	string	Total RAM on the device [in bytes] (Read-only)
tpmVersionInfo	object	Trusted Platform Module (TPM) (Read-only)
willAutoRenew	boolean	Determines if the device will auto renew its support after the support end date. This is a read-only property.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	customerId, deviceId	Retrieves a Chrome OS device's properties.
list	SELECT	customerId	Retrieves a paginated list of Chrome OS devices within an account.
_list	EXEC	customerId	Retrieves a paginated list of Chrome OS devices within an account.
action	EXEC	customerId, resourceId	Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. Warning: Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the help center.
moveDevicesToOu	EXEC	customerId, orgUnitPath	Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.
patch	EXEC	customerId, deviceId	Updates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId. This method supports patch semantics.
update	EXEC	customerId, deviceId	Updates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId.