Skip to main content

chromeosdevices

Creates, updates, deletes, gets or lists a chromeosdevices resource.

Overview

Namechromeosdevices
TypeResource
Idgoogleadmin.directory.chromeosdevices

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
activeTimeRangesarrayA list of active time ranges (Read-only).
annotatedAssetIdstringThe asset identifier as noted by an administrator or specified during enrollment.
annotatedLocationstringThe address or location of the device as noted by the administrator. Maximum length is 200 characters. Empty values are allowed.
annotatedUserstringThe user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
autoUpdateExpirationstring (int64)(Read-only) The timestamp after which the device will stop receiving Chrome updates or support. Please use "autoUpdateThrough" instead.
autoUpdateThroughstringOutput only. The timestamp after which the device will stop receiving Chrome updates or support.
backlightInfoarrayOutput only. Contains backlight information for the device.
bootModestringThe 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.
chromeOsTypestringOutput only. Chrome OS type of the device.
cpuInfoarrayInformation regarding CPU specs in the device.
cpuStatusReportsarrayReports of CPU utilization and temperature (Read-only)
deprovisionReasonstring(Read-only) Deprovision reason.
deviceFilesarrayA list of device files to download (Read-only)
deviceIdstringThe unique ID of the Chrome device.
deviceLicenseTypestringOutput only. Device license type.
diskSpaceUsageobjectOutput only. How much disk space the device has available and is currently using. (id: ByteUsage)
diskVolumeReportsarrayReports of disk space and other info about mounted/connected volumes.
dockMacAddressstring(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.
etagstringETag of the resource.
ethernetMacAddressstringThe device's MAC address on the ethernet network interface.
ethernetMacAddress0string(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.
extendedSupportEligiblebooleanOutput only. Whether or not the device requires the extended support opt in.
extendedSupportEnabledbooleanOutput only. Whether extended support policy is enabled on the device.
extendedSupportStartstringOutput only. Date of the device when extended support policy for automatic updates starts.
fanInfoarrayOutput only. Fan information for the device.
firmwareVersionstringThe Chrome device's firmware version.
firstEnrollmentTimestringDate and time for the first time the device was enrolled.
kindstringThe type of resource. For the Chromeosdevices resource, the value is admin#directory#chromeosdevice. (default: admin#directory#chromeosdevice)
lastDeprovisionTimestampstring(Read-only) Date and time for the last deprovision of the device.
lastEnrollmentTimestring (date-time)Date and time the device was last enrolled (Read-only)
lastKnownNetworkarrayContains last known network (Read-only)
lastSyncstring (date-time)Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
macAddressstringThe device's wireless MAC address. If the device does not have this information, it is not included in the response.
manufactureDatestring(Read-only) The date the device was manufactured in yyyy-mm-dd format.
meidstringThe 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.
modelstringThe device's model information. If the device does not have this information, this property is not included in the response.
notesstringNotes 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.
orderNumberstringThe device's order number. Only devices directly purchased from Google have an order number.
orgUnitIdstringThe 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.
orgUnitPathstringThe 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.
osUpdateStatusobjectThe status of the OS updates for the device. (id: OsUpdateStatus)
osVersionstringThe Chrome device's operating system version.
osVersionCompliancestringOutput only. Compliance status of the OS version.
platformVersionstringThe Chrome device's platform version.
recentUsersarrayA list of recent device users, in descending order, by last login time.
screenshotFilesarrayA list of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
serialNumberstringThe 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.
statusstringThe status of the device.
supportEndDatestring (date-time)Final date the device will be supported (Read-only)
systemRamFreeReportsarrayReports of amounts of available RAM memory (Read-only)
systemRamTotalstring (int64)Total RAM on the device [in bytes] (Read-only)
tpmVersionInfoobjectTrusted Platform Module (TPM) (Read-only)
willAutoRenewbooleanDetermines if the device will auto renew its support after the support end date. This is a read-only property.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectcustomerId, deviceIdprojectionRetrieves a Chrome OS device's properties.
listselectcustomerIdmaxResults, orderBy, orgUnitPath, pageToken, projection, query, sortOrder, includeChildOrgunitsRetrieves a paginated list of Chrome OS devices within an account.
patchupdatecustomerId, deviceIdprojectionUpdates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId. This method supports patch semantics.
updatereplacecustomerId, deviceIdprojectionUpdates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId.
actionexeccustomerId, resourceIdUse BatchChangeChromeOsDeviceStatus instead. 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.
move_devices_to_ouexeccustomerId, orgUnitPathMoves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
customerIdstring
deviceIdstring
orgUnitPathstring
resourceIdstring
includeChildOrgunitsboolean
maxResultsinteger (int32)
orderBystring
orgUnitPathstring
pageTokenstring
projectionstring
querystring
sortOrderstring

SELECT examples

Retrieves a Chrome OS device's properties.

SELECT
activeTimeRanges,
annotatedAssetId,
annotatedLocation,
annotatedUser,
autoUpdateExpiration,
autoUpdateThrough,
backlightInfo,
bootMode,
chromeOsType,
cpuInfo,
cpuStatusReports,
deprovisionReason,
deviceFiles,
deviceId,
deviceLicenseType,
diskSpaceUsage,
diskVolumeReports,
dockMacAddress,
etag,
ethernetMacAddress,
ethernetMacAddress0,
extendedSupportEligible,
extendedSupportEnabled,
extendedSupportStart,
fanInfo,
firmwareVersion,
firstEnrollmentTime,
kind,
lastDeprovisionTimestamp,
lastEnrollmentTime,
lastKnownNetwork,
lastSync,
macAddress,
manufactureDate,
meid,
model,
notes,
orderNumber,
orgUnitId,
orgUnitPath,
osUpdateStatus,
osVersion,
osVersionCompliance,
platformVersion,
recentUsers,
screenshotFiles,
serialNumber,
status,
supportEndDate,
systemRamFreeReports,
systemRamTotal,
tpmVersionInfo,
willAutoRenew
FROM googleadmin.directory.chromeosdevices
WHERE customerId = '{{ customerId }}' -- required
AND deviceId = '{{ deviceId }}' -- required
AND projection = '{{ projection }}';

UPDATE examples

Updates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId. This method supports patch semantics.

UPDATE googleadmin.directory.chromeosdevices
SET
data__deviceId = '{{ deviceId }}',
data__serialNumber = '{{ serialNumber }}',
data__status = '{{ status }}',
data__lastSync = '{{ lastSync }}',
data__supportEndDate = '{{ supportEndDate }}',
data__annotatedUser = '{{ annotatedUser }}',
data__annotatedLocation = '{{ annotatedLocation }}',
data__notes = '{{ notes }}',
data__model = '{{ model }}',
data__meid = '{{ meid }}',
data__orderNumber = '{{ orderNumber }}',
data__willAutoRenew = {{ willAutoRenew }},
data__osVersion = '{{ osVersion }}',
data__platformVersion = '{{ platformVersion }}',
data__firmwareVersion = '{{ firmwareVersion }}',
data__macAddress = '{{ macAddress }}',
data__bootMode = '{{ bootMode }}',
data__lastEnrollmentTime = '{{ lastEnrollmentTime }}',
data__kind = '{{ kind }}',
data__recentUsers = '{{ recentUsers }}',
data__activeTimeRanges = '{{ activeTimeRanges }}',
data__ethernetMacAddress = '{{ ethernetMacAddress }}',
data__annotatedAssetId = '{{ annotatedAssetId }}',
data__etag = '{{ etag }}',
data__diskVolumeReports = '{{ diskVolumeReports }}',
data__systemRamTotal = '{{ systemRamTotal }}',
data__cpuStatusReports = '{{ cpuStatusReports }}',
data__cpuInfo = '{{ cpuInfo }}',
data__deviceFiles = '{{ deviceFiles }}',
data__systemRamFreeReports = '{{ systemRamFreeReports }}',
data__lastKnownNetwork = '{{ lastKnownNetwork }}',
data__autoUpdateExpiration = '{{ autoUpdateExpiration }}',
data__ethernetMacAddress0 = '{{ ethernetMacAddress0 }}',
data__dockMacAddress = '{{ dockMacAddress }}',
data__manufactureDate = '{{ manufactureDate }}',
data__orgUnitPath = '{{ orgUnitPath }}',
data__tpmVersionInfo = '{{ tpmVersionInfo }}',
data__screenshotFiles = '{{ screenshotFiles }}',
data__orgUnitId = '{{ orgUnitId }}',
data__osUpdateStatus = '{{ osUpdateStatus }}',
data__firstEnrollmentTime = '{{ firstEnrollmentTime }}',
data__lastDeprovisionTimestamp = '{{ lastDeprovisionTimestamp }}',
data__deprovisionReason = '{{ deprovisionReason }}'
WHERE
customerId = '{{ customerId }}' --required
AND deviceId = '{{ deviceId }}' --required
AND projection = '{{ projection}}'
RETURNING
activeTimeRanges,
annotatedAssetId,
annotatedLocation,
annotatedUser,
autoUpdateExpiration,
autoUpdateThrough,
backlightInfo,
bootMode,
chromeOsType,
cpuInfo,
cpuStatusReports,
deprovisionReason,
deviceFiles,
deviceId,
deviceLicenseType,
diskSpaceUsage,
diskVolumeReports,
dockMacAddress,
etag,
ethernetMacAddress,
ethernetMacAddress0,
extendedSupportEligible,
extendedSupportEnabled,
extendedSupportStart,
fanInfo,
firmwareVersion,
firstEnrollmentTime,
kind,
lastDeprovisionTimestamp,
lastEnrollmentTime,
lastKnownNetwork,
lastSync,
macAddress,
manufactureDate,
meid,
model,
notes,
orderNumber,
orgUnitId,
orgUnitPath,
osUpdateStatus,
osVersion,
osVersionCompliance,
platformVersion,
recentUsers,
screenshotFiles,
serialNumber,
status,
supportEndDate,
systemRamFreeReports,
systemRamTotal,
tpmVersionInfo,
willAutoRenew;

REPLACE examples

Updates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId.

REPLACE googleadmin.directory.chromeosdevices
SET
data__deviceId = '{{ deviceId }}',
data__serialNumber = '{{ serialNumber }}',
data__status = '{{ status }}',
data__lastSync = '{{ lastSync }}',
data__supportEndDate = '{{ supportEndDate }}',
data__annotatedUser = '{{ annotatedUser }}',
data__annotatedLocation = '{{ annotatedLocation }}',
data__notes = '{{ notes }}',
data__model = '{{ model }}',
data__meid = '{{ meid }}',
data__orderNumber = '{{ orderNumber }}',
data__willAutoRenew = {{ willAutoRenew }},
data__osVersion = '{{ osVersion }}',
data__platformVersion = '{{ platformVersion }}',
data__firmwareVersion = '{{ firmwareVersion }}',
data__macAddress = '{{ macAddress }}',
data__bootMode = '{{ bootMode }}',
data__lastEnrollmentTime = '{{ lastEnrollmentTime }}',
data__kind = '{{ kind }}',
data__recentUsers = '{{ recentUsers }}',
data__activeTimeRanges = '{{ activeTimeRanges }}',
data__ethernetMacAddress = '{{ ethernetMacAddress }}',
data__annotatedAssetId = '{{ annotatedAssetId }}',
data__etag = '{{ etag }}',
data__diskVolumeReports = '{{ diskVolumeReports }}',
data__systemRamTotal = '{{ systemRamTotal }}',
data__cpuStatusReports = '{{ cpuStatusReports }}',
data__cpuInfo = '{{ cpuInfo }}',
data__deviceFiles = '{{ deviceFiles }}',
data__systemRamFreeReports = '{{ systemRamFreeReports }}',
data__lastKnownNetwork = '{{ lastKnownNetwork }}',
data__autoUpdateExpiration = '{{ autoUpdateExpiration }}',
data__ethernetMacAddress0 = '{{ ethernetMacAddress0 }}',
data__dockMacAddress = '{{ dockMacAddress }}',
data__manufactureDate = '{{ manufactureDate }}',
data__orgUnitPath = '{{ orgUnitPath }}',
data__tpmVersionInfo = '{{ tpmVersionInfo }}',
data__screenshotFiles = '{{ screenshotFiles }}',
data__orgUnitId = '{{ orgUnitId }}',
data__osUpdateStatus = '{{ osUpdateStatus }}',
data__firstEnrollmentTime = '{{ firstEnrollmentTime }}',
data__lastDeprovisionTimestamp = '{{ lastDeprovisionTimestamp }}',
data__deprovisionReason = '{{ deprovisionReason }}'
WHERE
customerId = '{{ customerId }}' --required
AND deviceId = '{{ deviceId }}' --required
AND projection = '{{ projection}}'
RETURNING
activeTimeRanges,
annotatedAssetId,
annotatedLocation,
annotatedUser,
autoUpdateExpiration,
autoUpdateThrough,
backlightInfo,
bootMode,
chromeOsType,
cpuInfo,
cpuStatusReports,
deprovisionReason,
deviceFiles,
deviceId,
deviceLicenseType,
diskSpaceUsage,
diskVolumeReports,
dockMacAddress,
etag,
ethernetMacAddress,
ethernetMacAddress0,
extendedSupportEligible,
extendedSupportEnabled,
extendedSupportStart,
fanInfo,
firmwareVersion,
firstEnrollmentTime,
kind,
lastDeprovisionTimestamp,
lastEnrollmentTime,
lastKnownNetwork,
lastSync,
macAddress,
manufactureDate,
meid,
model,
notes,
orderNumber,
orgUnitId,
orgUnitPath,
osUpdateStatus,
osVersion,
osVersionCompliance,
platformVersion,
recentUsers,
screenshotFiles,
serialNumber,
status,
supportEndDate,
systemRamFreeReports,
systemRamTotal,
tpmVersionInfo,
willAutoRenew;

Lifecycle Methods

Use BatchChangeChromeOsDeviceStatus instead. 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.

EXEC googleadmin.directory.chromeosdevices.action 
@customerId='{{ customerId }}' --required,
@resourceId='{{ resourceId }}' --required
@@json=
'{
"action": "{{ action }}",
"deprovisionReason": "{{ deprovisionReason }}"
}';