Chromeosdevices

Google Chrome devices run on the Chrome OS. For more information about common API tasks, see the Developer's Guide.

For a list of methods for this resource, see the end of this page.

Resource representations

The following JSON template is used for Chromeosdevices resources in the Directory API:

{
  "kind": "admin#directory#chromeosdevice",
  "etag": etag,
  "deviceId": string,
  "serialNumber": string,
  "status": string,
  "lastSync": datetime,
  "supportEndDate": datetime,
  "annotatedUser": string,
  "annotatedLocation": string,
  "annotatedAssetId": string,
  "notes": string,
  "model": string,
  "meid": string,
  "orderNumber": string,
  "willAutoRenew": boolean,
  "osVersion": string,
  "platformVersion": string,
  "firmwareVersion": string,
  "macAddress": string,
  "bootMode": string,
  "lastEnrollmentTime": datetime,
  "orgUnitPath": string,
  "recentUsers": [
    {
      "type": string,
      "email": string
    }
  ],
  "ethernetMacAddress": string,
  "activeTimeRanges": [
    {
      "date": date,
      "activeTime": integer
    }
  ],
  "deviceFiles": [
    {
      "name": string,
      "type": string,
      "downloadUrl": string,
      "createTime": datetime
    }
  ],
  "tpmVersionInfo": {
    "family": string,
    "specLevel": string,
    "manufacturer": string,
    "tpmModel": string,
    "firmwareVersion": string,
    "vendorSpecific": string
  },
  "cpuStatusReports": [
    {
      "reportTime": datetime,
      "cpuUtilizationPercentageInfo": [
        integer
      ],
      "cpuTemperatureInfo": [
        {
          "temperature": integer,
          "label": string
        }
      ]
    }
  ],
  "systemRamTotal": long,
  "systemRamFreeReports": [
    {
      "reportTime": datetime,
      "systemRamFreeInfo": [
        long
      ]
    }
  ],
  "diskVolumeReports": [
    {
      "volumeInfo": [
        {
          "volumeId": string,
          "storageTotal": long,
          "storageFree": long
        }
      ]
    }
  ],
  "ethernetMacAddress0": string,
  "dockMacAddress": string,
  "manufactureDate": string,
  "autoUpdateExpiration": long,
  "lastDeviceEnrollerEmail": string,
  "lastKnownNetwork": [
    {
      "ipAddress": string,
      "wanIpAddress": string
    }
  ]
}

Property name	Value	Description	Notes
`activeTimeRanges[]`	`list`	List of active time ranges (Read-only).
`activeTimeRanges[].activeTime`	`integer`	Duration of usage in milliseconds.
`activeTimeRanges[].date`	`date`	Date of usage.
`annotatedAssetId`	`string`	The asset identifier as noted by an administrator or specified during enrollment.	writable
`annotatedLocation`	`string`	The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.	writable
`annotatedUser`	`string`	The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.	writable
`autoUpdateExpiration`	`long`	(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.
`cpuStatusReports[]`	`list`	Reports of CPU utilization and temperature (Read-only)
`cpuStatusReports[].cpuTemperatureInfo[]`	`list`	List of CPU temperature samples.
`cpuStatusReports[].cpuTemperatureInfo[].label`	`string`	CPU label
`cpuStatusReports[].cpuTemperatureInfo[].temperature`	`integer`	Temperature in Celsius degrees.
`cpuStatusReports[].cpuUtilizationPercentageInfo[]`	`list`
`cpuStatusReports[].reportTime`	`datetime`	Date and time the report was received.
`deviceFiles[]`	`list`	List of device files to download (Read-only)
`deviceFiles[].createTime`	`datetime`	Date and time the file was created
`deviceFiles[].downloadUrl`	`string`	File download URL
`deviceFiles[].name`	`string`	File name
`deviceFiles[].type`	`string`	File type Acceptable values are: "`FILE_TYPE_UNSPECIFIED`" "`LOG_FILE`" "`SCREENSHOT_FILE`"
`deviceId`	`string`	The unique ID of the Chrome device.
`diskVolumeReports[]`	`list`	Reports of disk space and other info about mounted/connected volumes.
`diskVolumeReports[].volumeInfo[]`	`list`	Disk volumes
`diskVolumeReports[].volumeInfo[].storageFree`	`long`	Free disk space [in bytes]
`diskVolumeReports[].volumeInfo[].storageTotal`	`long`	Total disk space [in bytes]
`diskVolumeReports[].volumeInfo[].volumeId`	`string`	Volume id
`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`	`etag`	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.
`kind`	`string`	The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
`lastDeviceEnrollerEmail`	`string`	(Read-only) If device was re-enrolled after 07/2020, the E-mail of the user who re-enrolled the device. Otherwise, the E-mail of the user who originally enrolled the device.
`lastEnrollmentTime`	`datetime`	The date and time the device was last enrolled. The value is in ISO 8601ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form `YYYY-MM-DDThh:mm:ssTZD`. For example, `2010-04-05T17:30:04+01:00`. For more information about automatic and manual enrollment, see the Chrome help center.
`lastKnownNetwork[]`	`list`	Contains last used network (Read-only)
`lastKnownNetwork[].ipAddress`	`string`	The IP address
`lastKnownNetwork[].wanIpAddress`	`string`	The WAN IP address
`lastSync`	`datetime`	The date and time the device was last synchronized with the policy settings in the Admin console. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form `YYYY-MM-DDThh:mm:ssTZD`. For example, `2010-04-05T17:30:04+01:00`.
`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.	writable
`orderNumber`	`string`	The device's order number. Only devices directly purchased from Google have an order number.
`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.	writable
`osVersion`	`string`	The Chrome device's operating system version.
`platformVersion`	`string`	The Chrome device's platform version.
`recentUsers[]`	`list`	List of recent device users, in descending order, by last login time.
`recentUsers[].email`	`string`	The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
`recentUsers[].type`	`string`	The type of the user. Acceptable values are: "`USER_TYPE_MANAGED`": The user is managed by the domain. "`USER_TYPE_UNMANAGED`": The user is not managed by the domain.
`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. Acceptable values are: "`ACTIVE`": The device is enrolled into the domain. "`DELINQUENT`": The annual license for the domain has expired and the device no longer receives policies and settings. When a new license is purchased, the device will return to ACTIVE state. "`DEPROVISIONED`": The device is no longer eligible to be enrolled into the domain. The order has been cancelled. The device's settings have been cached on the device. If the device is activated again, the latest system settings are applied to this newly activated device. "`DISABLED`": The device has been disabled by the administrator and cannot be used. "`INACTIVE`": The device is not enrolled into the domain. "`RETURN_ARRIVED`": The request to replace this device has arrived. "`RETURN_REQUESTED`": A request has been made to replace this device. "`SHIPPED`": The device is shipped. For details on how to track a shipped device, see the Chrome help center. "`UNKNOWN`": The status of the device cannot be determined.
`supportEndDate`	`datetime`	The final date the device will be supported. This is applicable only for those devices purchased directly from Google. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form `YYYY-MM-DDThh:mm:ssTZD`. For example, `2010-04-05T17:30:04+01:00`.
`systemRamFreeReports[]`	`list`	Reports of amounts of available RAM memory (Read-only)
`systemRamFreeReports[].reportTime`	`datetime`	Date and time the report was received.
`systemRamFreeReports[].systemRamFreeInfo[]`	`list`
`systemRamTotal`	`long`	Total RAM on the device [in bytes] (Read-only)
`tpmVersionInfo`	`object`	Trusted Platform Module (TPM) (Read-only)
`tpmVersionInfo.family`	`string`	TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: "1.2" -> 312e3200 TPM 2.0: "2.0" -> 322e3000
`tpmVersionInfo.firmwareVersion`	`string`	TPM firmware version.
`tpmVersionInfo.manufacturer`	`string`	TPM manufacturer code.
`tpmVersionInfo.specLevel`	`string`	TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.
`tpmVersionInfo.tpmModel`	`string`	TPM model number.
`tpmVersionInfo.vendorSpecific`	`string`	Vendor-specific information such as Vendor ID.
`willAutoRenew`	`boolean`	Determines if the device will auto renew its support after the support end date. This is a read-only property. Possible values are: `true`: The support will be automatically renewed. This is the default value. `false`: The support will not be automatically renewed.

Methods

action: Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices.
get: Retrieves a Chrome OS device's properties.
list: Retrieves a paginated list of Chrome OS devices within an account.
moveDevicesToOu: Move or insert multiple Chrome OS devices to an organizational unit.
You can move up to 50 devices at once.
patch: Updates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId. This method supports patch semantics.
update: Updates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId.