action(customerId, resourceId, body=None, x__xgafv=None)
Use [BatchChangeChromeOsDeviceStatus](/admin-sdk/directory/reference/rest/v1/customer.devices.chromeos/batchChangeStatus) 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](https://support.google.com/chrome/a/answer/3523633).
Close httplib2 connections.
get(customerId, deviceId, projection=None, x__xgafv=None)
Retrieves a Chrome OS device's properties.
Retrieves a paginated list of Chrome OS devices within an account.
Retrieves the next page of results.
moveDevicesToOu(customerId, orgUnitPath, body=None, x__xgafv=None)
Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.
patch(customerId, deviceId, body=None, projection=None, x__xgafv=None)
Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
update(customerId, deviceId, body=None, projection=None, x__xgafv=None)
Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.
action(customerId, resourceId, body=None, x__xgafv=None)
Use [BatchChangeChromeOsDeviceStatus](/admin-sdk/directory/reference/rest/v1/customer.devices.chromeos/batchChangeStatus) 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](https://support.google.com/chrome/a/answer/3523633).
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
resourceId: string, The unique ID of the device. The `resourceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method. (required)
body: object, The request body.
The object takes the form of:
{ # Data about an update to the status of a Chrome OS device.
"action": "A String", # Action to be taken on the Chrome OS device.
"deprovisionReason": "A String", # Only used when the action is `deprovision`. With the `deprovision` action, this field is required. *Note*: The deprovision reason is audited because it might have implications on licenses for perpetual subscription customers.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
close()
Close httplib2 connections.
get(customerId, deviceId, projection=None, x__xgafv=None)
Retrieves a Chrome OS device's properties.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
deviceId: string, The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method. (required)
projection: string, Determines whether the response contains the full list of properties or only a subset.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
FULL - Includes all metadata fields
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).
"activeTimeRanges": [ # A list of active time ranges (Read-only).
{
"activeTime": 42, # Duration of usage in milliseconds.
"date": "A String", # Date of usage
},
],
"annotatedAssetId": "A String", # The asset identifier as noted by an administrator or specified during enrollment.
"annotatedLocation": "A String", # The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.
"annotatedUser": "A String", # The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
"autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support. Please use "autoUpdateThrough" instead.
"autoUpdateThrough": "A String", # Output only. The timestamp after which the device will stop receiving Chrome updates or support.
"backlightInfo": [ # Output only. Contains backlight information for the device.
{ # Information about the device's backlights.
"brightness": 42, # Output only. Current brightness of the backlight, between 0 and max_brightness.
"maxBrightness": 42, # Output only. Maximum brightness for the backlight.
"path": "A String", # Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information.
},
],
"bootMode": "A 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](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).
"chromeOsType": "A String", # Output only. Chrome OS type of the device.
"cpuInfo": [ # Information regarding CPU specs in the device.
{ # CPU specs for a CPU.
"architecture": "A String", # The CPU architecture.
"logicalCpus": [ # Information for the Logical CPUs
{ # Status of a single logical CPU.
"cStates": [ # C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.
{ # Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.
"displayName": "A String", # Name of the state.
"sessionDuration": "A String", # Time spent in the state since the last reboot.
},
],
"currentScalingFrequencyKhz": 42, # Current frequency the CPU is running at.
"idleDuration": "A String", # Idle time since last boot.
"maxScalingFrequencyKhz": 42, # Maximum frequency the CPU is allowed to run at, by policy.
},
],
"maxClockSpeedKhz": 42, # The max CPU clock speed in kHz.
"model": "A String", # The CPU model name.
},
],
"cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only)
{
"cpuTemperatureInfo": [ # A list of CPU temperature samples.
{
"label": "A String", # CPU label
"temperature": 42, # Temperature in Celsius degrees.
},
],
"cpuUtilizationPercentageInfo": [
42,
],
"reportTime": "A String", # Date and time the report was received.
},
],
"deprovisionReason": "A String", # (Read-only) Deprovision reason.
"deviceFiles": [ # A list of device files to download (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"deviceId": "A String", # The unique ID of the Chrome device.
"deviceLicenseType": "A String", # Output only. Device license type.
"diskSpaceUsage": { # Represents a data capacity with some amount of current usage in bytes. # Output only. How much disk space the device has available and is currently using.
"capacityBytes": "A String", # Output only. The total capacity value, in bytes.
"usedBytes": "A String", # Output only. The current usage value, in bytes.
},
"diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes.
{
"volumeInfo": [ # Disk volumes
{
"storageFree": "A String", # Free disk space [in bytes]
"storageTotal": "A String", # Total disk space [in bytes]
"volumeId": "A String", # Volume id
},
],
},
],
"dockMacAddress": "A 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": "A String", # ETag of the resource.
"ethernetMacAddress": "A String", # The device's MAC address on the ethernet network interface.
"ethernetMacAddress0": "A 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.
"extendedSupportEligible": True or False, # Output only. Whether or not the device requires the extended support opt in.
"extendedSupportEnabled": True or False, # Output only. Whether extended support policy is enabled on the device.
"extendedSupportStart": "A String", # Output only. Date of the device when extended support policy for automatic updates starts.
"fanInfo": [ # Output only. Fan information for the device.
{ # Information about the device's fan.
"speedRpm": 42, # Output only. Fan speed in RPM.
},
],
"firmwareVersion": "A String", # The Chrome device's firmware version.
"firstEnrollmentTime": "A String", # Date and time for the first time the device was enrolled.
"kind": "admin#directory#chromeosdevice", # The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
"lastDeprovisionTimestamp": "A String", # (Read-only) Date and time for the last deprovision of the device.
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"lastKnownNetwork": [ # Contains last known network (Read-only)
{ # Information for an ip address.
"ipAddress": "A String", # The IP address.
"wanIpAddress": "A String", # The WAN IP address.
},
],
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response.
"manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format.
"meid": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).
"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response.
"notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.
"orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number.
"orgUnitId": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"orgUnitPath": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"osUpdateStatus": { # Contains information regarding the current OS update status. # The status of the OS updates for the device.
"rebootTime": "A String", # Date and time of the last reboot.
"state": "A String", # The update state of an OS update.
"targetKioskAppVersion": "A String", # New required platform version from the pending updated kiosk app.
"targetOsVersion": "A String", # New platform version of the OS image being downloaded and applied. It is only set when update status is UPDATE_STATUS_DOWNLOAD_IN_PROGRESS or UPDATE_STATUS_NEED_REBOOT. Note this could be a dummy "0.0.0.0" for UPDATE_STATUS_NEED_REBOOT for some edge cases, e.g. update engine is restarted without a reboot.
"updateCheckTime": "A String", # Date and time of the last update check.
"updateTime": "A String", # Date and time of the last successful OS update.
},
"osVersion": "A String", # The Chrome device's operating system version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # A list of recent device users, in descending order, by last login time.
{ # A list of recent device users, in descending order, by last login time.
"email": "A String", # The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
"type": "A String", # The type of the user.
},
],
"screenshotFiles": [ # A list of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"serialNumber": "A 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": "A String", # The status of the device.
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only)
{
"reportTime": "A String", # Date and time the report was received.
"systemRamFreeInfo": [
"A String",
],
},
],
"systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only)
"tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only)
"family": "A 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
"firmwareVersion": "A String", # TPM firmware version.
"manufacturer": "A String", # TPM manufacturer code.
"specLevel": "A String", # TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.
"tpmModel": "A String", # TPM model number.
"vendorSpecific": "A String", # Vendor-specific information such as Vendor ID.
},
"willAutoRenew": True or False, # Determines if the device will auto renew its support after the support end date. This is a read-only property.
}
list(customerId, includeChildOrgunits=None, maxResults=None, orderBy=None, orgUnitPath=None, pageToken=None, projection=None, query=None, sortOrder=None, x__xgafv=None)
Retrieves a paginated list of Chrome OS devices within an account.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
includeChildOrgunits: boolean, Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided.
maxResults: integer, Maximum number of results to return. Value should not exceed 300.
orderBy: string, Device property to use for sorting results.
Allowed values
annotatedLocation - Chrome device location as annotated by the administrator.
annotatedUser - Chromebook user as annotated by administrator.
lastSync - The date and time the Chrome device was last synchronized with the policy settings in the Admin console.
notes - Chrome device notes as annotated by the administrator.
serialNumber - The Chrome device serial number entered when the device was enabled.
status - Chrome device status. For more information, see the <a [chromeosdevices](/admin-sdk/directory/v1/reference/chromeosdevices.html).
orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID.
pageToken: string, The `pageToken` query parameter is used to request the next page of query results. The follow-on request's `pageToken` query parameter is the `nextPageToken` from your previous response.
projection: string, Determines whether the response contains the full list of properties or only a subset.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
FULL - Includes all metadata fields
query: string, Search string in the format given at https://developers.google.com/admin-sdk/directory/v1/list-query-operators
sortOrder: string, Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"chromeosdevices": [ # A list of Chrome OS Device objects.
{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).
"activeTimeRanges": [ # A list of active time ranges (Read-only).
{
"activeTime": 42, # Duration of usage in milliseconds.
"date": "A String", # Date of usage
},
],
"annotatedAssetId": "A String", # The asset identifier as noted by an administrator or specified during enrollment.
"annotatedLocation": "A String", # The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.
"annotatedUser": "A String", # The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
"autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support. Please use "autoUpdateThrough" instead.
"autoUpdateThrough": "A String", # Output only. The timestamp after which the device will stop receiving Chrome updates or support.
"backlightInfo": [ # Output only. Contains backlight information for the device.
{ # Information about the device's backlights.
"brightness": 42, # Output only. Current brightness of the backlight, between 0 and max_brightness.
"maxBrightness": 42, # Output only. Maximum brightness for the backlight.
"path": "A String", # Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information.
},
],
"bootMode": "A 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](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).
"chromeOsType": "A String", # Output only. Chrome OS type of the device.
"cpuInfo": [ # Information regarding CPU specs in the device.
{ # CPU specs for a CPU.
"architecture": "A String", # The CPU architecture.
"logicalCpus": [ # Information for the Logical CPUs
{ # Status of a single logical CPU.
"cStates": [ # C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.
{ # Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.
"displayName": "A String", # Name of the state.
"sessionDuration": "A String", # Time spent in the state since the last reboot.
},
],
"currentScalingFrequencyKhz": 42, # Current frequency the CPU is running at.
"idleDuration": "A String", # Idle time since last boot.
"maxScalingFrequencyKhz": 42, # Maximum frequency the CPU is allowed to run at, by policy.
},
],
"maxClockSpeedKhz": 42, # The max CPU clock speed in kHz.
"model": "A String", # The CPU model name.
},
],
"cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only)
{
"cpuTemperatureInfo": [ # A list of CPU temperature samples.
{
"label": "A String", # CPU label
"temperature": 42, # Temperature in Celsius degrees.
},
],
"cpuUtilizationPercentageInfo": [
42,
],
"reportTime": "A String", # Date and time the report was received.
},
],
"deprovisionReason": "A String", # (Read-only) Deprovision reason.
"deviceFiles": [ # A list of device files to download (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"deviceId": "A String", # The unique ID of the Chrome device.
"deviceLicenseType": "A String", # Output only. Device license type.
"diskSpaceUsage": { # Represents a data capacity with some amount of current usage in bytes. # Output only. How much disk space the device has available and is currently using.
"capacityBytes": "A String", # Output only. The total capacity value, in bytes.
"usedBytes": "A String", # Output only. The current usage value, in bytes.
},
"diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes.
{
"volumeInfo": [ # Disk volumes
{
"storageFree": "A String", # Free disk space [in bytes]
"storageTotal": "A String", # Total disk space [in bytes]
"volumeId": "A String", # Volume id
},
],
},
],
"dockMacAddress": "A 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": "A String", # ETag of the resource.
"ethernetMacAddress": "A String", # The device's MAC address on the ethernet network interface.
"ethernetMacAddress0": "A 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.
"extendedSupportEligible": True or False, # Output only. Whether or not the device requires the extended support opt in.
"extendedSupportEnabled": True or False, # Output only. Whether extended support policy is enabled on the device.
"extendedSupportStart": "A String", # Output only. Date of the device when extended support policy for automatic updates starts.
"fanInfo": [ # Output only. Fan information for the device.
{ # Information about the device's fan.
"speedRpm": 42, # Output only. Fan speed in RPM.
},
],
"firmwareVersion": "A String", # The Chrome device's firmware version.
"firstEnrollmentTime": "A String", # Date and time for the first time the device was enrolled.
"kind": "admin#directory#chromeosdevice", # The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
"lastDeprovisionTimestamp": "A String", # (Read-only) Date and time for the last deprovision of the device.
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"lastKnownNetwork": [ # Contains last known network (Read-only)
{ # Information for an ip address.
"ipAddress": "A String", # The IP address.
"wanIpAddress": "A String", # The WAN IP address.
},
],
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response.
"manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format.
"meid": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).
"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response.
"notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.
"orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number.
"orgUnitId": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"orgUnitPath": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"osUpdateStatus": { # Contains information regarding the current OS update status. # The status of the OS updates for the device.
"rebootTime": "A String", # Date and time of the last reboot.
"state": "A String", # The update state of an OS update.
"targetKioskAppVersion": "A String", # New required platform version from the pending updated kiosk app.
"targetOsVersion": "A String", # New platform version of the OS image being downloaded and applied. It is only set when update status is UPDATE_STATUS_DOWNLOAD_IN_PROGRESS or UPDATE_STATUS_NEED_REBOOT. Note this could be a dummy "0.0.0.0" for UPDATE_STATUS_NEED_REBOOT for some edge cases, e.g. update engine is restarted without a reboot.
"updateCheckTime": "A String", # Date and time of the last update check.
"updateTime": "A String", # Date and time of the last successful OS update.
},
"osVersion": "A String", # The Chrome device's operating system version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # A list of recent device users, in descending order, by last login time.
{ # A list of recent device users, in descending order, by last login time.
"email": "A String", # The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
"type": "A String", # The type of the user.
},
],
"screenshotFiles": [ # A list of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"serialNumber": "A 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": "A String", # The status of the device.
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only)
{
"reportTime": "A String", # Date and time the report was received.
"systemRamFreeInfo": [
"A String",
],
},
],
"systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only)
"tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only)
"family": "A 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
"firmwareVersion": "A String", # TPM firmware version.
"manufacturer": "A String", # TPM manufacturer code.
"specLevel": "A String", # TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.
"tpmModel": "A String", # TPM model number.
"vendorSpecific": "A String", # Vendor-specific information such as Vendor ID.
},
"willAutoRenew": True or False, # Determines if the device will auto renew its support after the support end date. This is a read-only property.
},
],
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#chromeosdevices", # Kind of resource this is.
"nextPageToken": "A String", # Token used to access the next page of this result. To access the next page, use this token's value in the `pageToken` query string of this request.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
moveDevicesToOu(customerId, orgUnitPath, body=None, x__xgafv=None)
Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.
Args:
customerId: string, Immutable. ID of the Google Workspace account (required)
orgUnitPath: string, Full path of the target organizational unit or its ID (required)
body: object, The request body.
The object takes the form of:
{
"deviceIds": [ # Chrome OS devices to be moved to OU
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
patch(customerId, deviceId, body=None, projection=None, x__xgafv=None)
Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
deviceId: string, The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) method. (required)
body: object, The request body.
The object takes the form of:
{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).
"activeTimeRanges": [ # A list of active time ranges (Read-only).
{
"activeTime": 42, # Duration of usage in milliseconds.
"date": "A String", # Date of usage
},
],
"annotatedAssetId": "A String", # The asset identifier as noted by an administrator or specified during enrollment.
"annotatedLocation": "A String", # The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.
"annotatedUser": "A String", # The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
"autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support. Please use "autoUpdateThrough" instead.
"autoUpdateThrough": "A String", # Output only. The timestamp after which the device will stop receiving Chrome updates or support.
"backlightInfo": [ # Output only. Contains backlight information for the device.
{ # Information about the device's backlights.
"brightness": 42, # Output only. Current brightness of the backlight, between 0 and max_brightness.
"maxBrightness": 42, # Output only. Maximum brightness for the backlight.
"path": "A String", # Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information.
},
],
"bootMode": "A 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](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).
"chromeOsType": "A String", # Output only. Chrome OS type of the device.
"cpuInfo": [ # Information regarding CPU specs in the device.
{ # CPU specs for a CPU.
"architecture": "A String", # The CPU architecture.
"logicalCpus": [ # Information for the Logical CPUs
{ # Status of a single logical CPU.
"cStates": [ # C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.
{ # Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.
"displayName": "A String", # Name of the state.
"sessionDuration": "A String", # Time spent in the state since the last reboot.
},
],
"currentScalingFrequencyKhz": 42, # Current frequency the CPU is running at.
"idleDuration": "A String", # Idle time since last boot.
"maxScalingFrequencyKhz": 42, # Maximum frequency the CPU is allowed to run at, by policy.
},
],
"maxClockSpeedKhz": 42, # The max CPU clock speed in kHz.
"model": "A String", # The CPU model name.
},
],
"cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only)
{
"cpuTemperatureInfo": [ # A list of CPU temperature samples.
{
"label": "A String", # CPU label
"temperature": 42, # Temperature in Celsius degrees.
},
],
"cpuUtilizationPercentageInfo": [
42,
],
"reportTime": "A String", # Date and time the report was received.
},
],
"deprovisionReason": "A String", # (Read-only) Deprovision reason.
"deviceFiles": [ # A list of device files to download (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"deviceId": "A String", # The unique ID of the Chrome device.
"deviceLicenseType": "A String", # Output only. Device license type.
"diskSpaceUsage": { # Represents a data capacity with some amount of current usage in bytes. # Output only. How much disk space the device has available and is currently using.
"capacityBytes": "A String", # Output only. The total capacity value, in bytes.
"usedBytes": "A String", # Output only. The current usage value, in bytes.
},
"diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes.
{
"volumeInfo": [ # Disk volumes
{
"storageFree": "A String", # Free disk space [in bytes]
"storageTotal": "A String", # Total disk space [in bytes]
"volumeId": "A String", # Volume id
},
],
},
],
"dockMacAddress": "A 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": "A String", # ETag of the resource.
"ethernetMacAddress": "A String", # The device's MAC address on the ethernet network interface.
"ethernetMacAddress0": "A 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.
"extendedSupportEligible": True or False, # Output only. Whether or not the device requires the extended support opt in.
"extendedSupportEnabled": True or False, # Output only. Whether extended support policy is enabled on the device.
"extendedSupportStart": "A String", # Output only. Date of the device when extended support policy for automatic updates starts.
"fanInfo": [ # Output only. Fan information for the device.
{ # Information about the device's fan.
"speedRpm": 42, # Output only. Fan speed in RPM.
},
],
"firmwareVersion": "A String", # The Chrome device's firmware version.
"firstEnrollmentTime": "A String", # Date and time for the first time the device was enrolled.
"kind": "admin#directory#chromeosdevice", # The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
"lastDeprovisionTimestamp": "A String", # (Read-only) Date and time for the last deprovision of the device.
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"lastKnownNetwork": [ # Contains last known network (Read-only)
{ # Information for an ip address.
"ipAddress": "A String", # The IP address.
"wanIpAddress": "A String", # The WAN IP address.
},
],
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response.
"manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format.
"meid": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).
"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response.
"notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.
"orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number.
"orgUnitId": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"orgUnitPath": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"osUpdateStatus": { # Contains information regarding the current OS update status. # The status of the OS updates for the device.
"rebootTime": "A String", # Date and time of the last reboot.
"state": "A String", # The update state of an OS update.
"targetKioskAppVersion": "A String", # New required platform version from the pending updated kiosk app.
"targetOsVersion": "A String", # New platform version of the OS image being downloaded and applied. It is only set when update status is UPDATE_STATUS_DOWNLOAD_IN_PROGRESS or UPDATE_STATUS_NEED_REBOOT. Note this could be a dummy "0.0.0.0" for UPDATE_STATUS_NEED_REBOOT for some edge cases, e.g. update engine is restarted without a reboot.
"updateCheckTime": "A String", # Date and time of the last update check.
"updateTime": "A String", # Date and time of the last successful OS update.
},
"osVersion": "A String", # The Chrome device's operating system version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # A list of recent device users, in descending order, by last login time.
{ # A list of recent device users, in descending order, by last login time.
"email": "A String", # The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
"type": "A String", # The type of the user.
},
],
"screenshotFiles": [ # A list of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"serialNumber": "A 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": "A String", # The status of the device.
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only)
{
"reportTime": "A String", # Date and time the report was received.
"systemRamFreeInfo": [
"A String",
],
},
],
"systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only)
"tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only)
"family": "A 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
"firmwareVersion": "A String", # TPM firmware version.
"manufacturer": "A String", # TPM manufacturer code.
"specLevel": "A String", # TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.
"tpmModel": "A String", # TPM model number.
"vendorSpecific": "A String", # Vendor-specific information such as Vendor ID.
},
"willAutoRenew": True or False, # Determines if the device will auto renew its support after the support end date. This is a read-only property.
}
projection: string, Determines whether the response contains the full list of properties or only a subset.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
FULL - Includes all metadata fields
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).
"activeTimeRanges": [ # A list of active time ranges (Read-only).
{
"activeTime": 42, # Duration of usage in milliseconds.
"date": "A String", # Date of usage
},
],
"annotatedAssetId": "A String", # The asset identifier as noted by an administrator or specified during enrollment.
"annotatedLocation": "A String", # The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.
"annotatedUser": "A String", # The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
"autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support. Please use "autoUpdateThrough" instead.
"autoUpdateThrough": "A String", # Output only. The timestamp after which the device will stop receiving Chrome updates or support.
"backlightInfo": [ # Output only. Contains backlight information for the device.
{ # Information about the device's backlights.
"brightness": 42, # Output only. Current brightness of the backlight, between 0 and max_brightness.
"maxBrightness": 42, # Output only. Maximum brightness for the backlight.
"path": "A String", # Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information.
},
],
"bootMode": "A 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](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).
"chromeOsType": "A String", # Output only. Chrome OS type of the device.
"cpuInfo": [ # Information regarding CPU specs in the device.
{ # CPU specs for a CPU.
"architecture": "A String", # The CPU architecture.
"logicalCpus": [ # Information for the Logical CPUs
{ # Status of a single logical CPU.
"cStates": [ # C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.
{ # Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.
"displayName": "A String", # Name of the state.
"sessionDuration": "A String", # Time spent in the state since the last reboot.
},
],
"currentScalingFrequencyKhz": 42, # Current frequency the CPU is running at.
"idleDuration": "A String", # Idle time since last boot.
"maxScalingFrequencyKhz": 42, # Maximum frequency the CPU is allowed to run at, by policy.
},
],
"maxClockSpeedKhz": 42, # The max CPU clock speed in kHz.
"model": "A String", # The CPU model name.
},
],
"cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only)
{
"cpuTemperatureInfo": [ # A list of CPU temperature samples.
{
"label": "A String", # CPU label
"temperature": 42, # Temperature in Celsius degrees.
},
],
"cpuUtilizationPercentageInfo": [
42,
],
"reportTime": "A String", # Date and time the report was received.
},
],
"deprovisionReason": "A String", # (Read-only) Deprovision reason.
"deviceFiles": [ # A list of device files to download (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"deviceId": "A String", # The unique ID of the Chrome device.
"deviceLicenseType": "A String", # Output only. Device license type.
"diskSpaceUsage": { # Represents a data capacity with some amount of current usage in bytes. # Output only. How much disk space the device has available and is currently using.
"capacityBytes": "A String", # Output only. The total capacity value, in bytes.
"usedBytes": "A String", # Output only. The current usage value, in bytes.
},
"diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes.
{
"volumeInfo": [ # Disk volumes
{
"storageFree": "A String", # Free disk space [in bytes]
"storageTotal": "A String", # Total disk space [in bytes]
"volumeId": "A String", # Volume id
},
],
},
],
"dockMacAddress": "A 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": "A String", # ETag of the resource.
"ethernetMacAddress": "A String", # The device's MAC address on the ethernet network interface.
"ethernetMacAddress0": "A 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.
"extendedSupportEligible": True or False, # Output only. Whether or not the device requires the extended support opt in.
"extendedSupportEnabled": True or False, # Output only. Whether extended support policy is enabled on the device.
"extendedSupportStart": "A String", # Output only. Date of the device when extended support policy for automatic updates starts.
"fanInfo": [ # Output only. Fan information for the device.
{ # Information about the device's fan.
"speedRpm": 42, # Output only. Fan speed in RPM.
},
],
"firmwareVersion": "A String", # The Chrome device's firmware version.
"firstEnrollmentTime": "A String", # Date and time for the first time the device was enrolled.
"kind": "admin#directory#chromeosdevice", # The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
"lastDeprovisionTimestamp": "A String", # (Read-only) Date and time for the last deprovision of the device.
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"lastKnownNetwork": [ # Contains last known network (Read-only)
{ # Information for an ip address.
"ipAddress": "A String", # The IP address.
"wanIpAddress": "A String", # The WAN IP address.
},
],
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response.
"manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format.
"meid": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).
"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response.
"notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.
"orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number.
"orgUnitId": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"orgUnitPath": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"osUpdateStatus": { # Contains information regarding the current OS update status. # The status of the OS updates for the device.
"rebootTime": "A String", # Date and time of the last reboot.
"state": "A String", # The update state of an OS update.
"targetKioskAppVersion": "A String", # New required platform version from the pending updated kiosk app.
"targetOsVersion": "A String", # New platform version of the OS image being downloaded and applied. It is only set when update status is UPDATE_STATUS_DOWNLOAD_IN_PROGRESS or UPDATE_STATUS_NEED_REBOOT. Note this could be a dummy "0.0.0.0" for UPDATE_STATUS_NEED_REBOOT for some edge cases, e.g. update engine is restarted without a reboot.
"updateCheckTime": "A String", # Date and time of the last update check.
"updateTime": "A String", # Date and time of the last successful OS update.
},
"osVersion": "A String", # The Chrome device's operating system version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # A list of recent device users, in descending order, by last login time.
{ # A list of recent device users, in descending order, by last login time.
"email": "A String", # The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
"type": "A String", # The type of the user.
},
],
"screenshotFiles": [ # A list of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"serialNumber": "A 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": "A String", # The status of the device.
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only)
{
"reportTime": "A String", # Date and time the report was received.
"systemRamFreeInfo": [
"A String",
],
},
],
"systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only)
"tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only)
"family": "A 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
"firmwareVersion": "A String", # TPM firmware version.
"manufacturer": "A String", # TPM manufacturer code.
"specLevel": "A String", # TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.
"tpmModel": "A String", # TPM model number.
"vendorSpecific": "A String", # Vendor-specific information such as Vendor ID.
},
"willAutoRenew": True or False, # Determines if the device will auto renew its support after the support end date. This is a read-only property.
}
update(customerId, deviceId, body=None, projection=None, x__xgafv=None)
Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
deviceId: string, The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) method. (required)
body: object, The request body.
The object takes the form of:
{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).
"activeTimeRanges": [ # A list of active time ranges (Read-only).
{
"activeTime": 42, # Duration of usage in milliseconds.
"date": "A String", # Date of usage
},
],
"annotatedAssetId": "A String", # The asset identifier as noted by an administrator or specified during enrollment.
"annotatedLocation": "A String", # The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.
"annotatedUser": "A String", # The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
"autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support. Please use "autoUpdateThrough" instead.
"autoUpdateThrough": "A String", # Output only. The timestamp after which the device will stop receiving Chrome updates or support.
"backlightInfo": [ # Output only. Contains backlight information for the device.
{ # Information about the device's backlights.
"brightness": 42, # Output only. Current brightness of the backlight, between 0 and max_brightness.
"maxBrightness": 42, # Output only. Maximum brightness for the backlight.
"path": "A String", # Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information.
},
],
"bootMode": "A 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](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).
"chromeOsType": "A String", # Output only. Chrome OS type of the device.
"cpuInfo": [ # Information regarding CPU specs in the device.
{ # CPU specs for a CPU.
"architecture": "A String", # The CPU architecture.
"logicalCpus": [ # Information for the Logical CPUs
{ # Status of a single logical CPU.
"cStates": [ # C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.
{ # Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.
"displayName": "A String", # Name of the state.
"sessionDuration": "A String", # Time spent in the state since the last reboot.
},
],
"currentScalingFrequencyKhz": 42, # Current frequency the CPU is running at.
"idleDuration": "A String", # Idle time since last boot.
"maxScalingFrequencyKhz": 42, # Maximum frequency the CPU is allowed to run at, by policy.
},
],
"maxClockSpeedKhz": 42, # The max CPU clock speed in kHz.
"model": "A String", # The CPU model name.
},
],
"cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only)
{
"cpuTemperatureInfo": [ # A list of CPU temperature samples.
{
"label": "A String", # CPU label
"temperature": 42, # Temperature in Celsius degrees.
},
],
"cpuUtilizationPercentageInfo": [
42,
],
"reportTime": "A String", # Date and time the report was received.
},
],
"deprovisionReason": "A String", # (Read-only) Deprovision reason.
"deviceFiles": [ # A list of device files to download (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"deviceId": "A String", # The unique ID of the Chrome device.
"deviceLicenseType": "A String", # Output only. Device license type.
"diskSpaceUsage": { # Represents a data capacity with some amount of current usage in bytes. # Output only. How much disk space the device has available and is currently using.
"capacityBytes": "A String", # Output only. The total capacity value, in bytes.
"usedBytes": "A String", # Output only. The current usage value, in bytes.
},
"diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes.
{
"volumeInfo": [ # Disk volumes
{
"storageFree": "A String", # Free disk space [in bytes]
"storageTotal": "A String", # Total disk space [in bytes]
"volumeId": "A String", # Volume id
},
],
},
],
"dockMacAddress": "A 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": "A String", # ETag of the resource.
"ethernetMacAddress": "A String", # The device's MAC address on the ethernet network interface.
"ethernetMacAddress0": "A 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.
"extendedSupportEligible": True or False, # Output only. Whether or not the device requires the extended support opt in.
"extendedSupportEnabled": True or False, # Output only. Whether extended support policy is enabled on the device.
"extendedSupportStart": "A String", # Output only. Date of the device when extended support policy for automatic updates starts.
"fanInfo": [ # Output only. Fan information for the device.
{ # Information about the device's fan.
"speedRpm": 42, # Output only. Fan speed in RPM.
},
],
"firmwareVersion": "A String", # The Chrome device's firmware version.
"firstEnrollmentTime": "A String", # Date and time for the first time the device was enrolled.
"kind": "admin#directory#chromeosdevice", # The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
"lastDeprovisionTimestamp": "A String", # (Read-only) Date and time for the last deprovision of the device.
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"lastKnownNetwork": [ # Contains last known network (Read-only)
{ # Information for an ip address.
"ipAddress": "A String", # The IP address.
"wanIpAddress": "A String", # The WAN IP address.
},
],
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response.
"manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format.
"meid": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).
"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response.
"notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.
"orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number.
"orgUnitId": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"orgUnitPath": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"osUpdateStatus": { # Contains information regarding the current OS update status. # The status of the OS updates for the device.
"rebootTime": "A String", # Date and time of the last reboot.
"state": "A String", # The update state of an OS update.
"targetKioskAppVersion": "A String", # New required platform version from the pending updated kiosk app.
"targetOsVersion": "A String", # New platform version of the OS image being downloaded and applied. It is only set when update status is UPDATE_STATUS_DOWNLOAD_IN_PROGRESS or UPDATE_STATUS_NEED_REBOOT. Note this could be a dummy "0.0.0.0" for UPDATE_STATUS_NEED_REBOOT for some edge cases, e.g. update engine is restarted without a reboot.
"updateCheckTime": "A String", # Date and time of the last update check.
"updateTime": "A String", # Date and time of the last successful OS update.
},
"osVersion": "A String", # The Chrome device's operating system version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # A list of recent device users, in descending order, by last login time.
{ # A list of recent device users, in descending order, by last login time.
"email": "A String", # The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
"type": "A String", # The type of the user.
},
],
"screenshotFiles": [ # A list of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"serialNumber": "A 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": "A String", # The status of the device.
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only)
{
"reportTime": "A String", # Date and time the report was received.
"systemRamFreeInfo": [
"A String",
],
},
],
"systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only)
"tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only)
"family": "A 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
"firmwareVersion": "A String", # TPM firmware version.
"manufacturer": "A String", # TPM manufacturer code.
"specLevel": "A String", # TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.
"tpmModel": "A String", # TPM model number.
"vendorSpecific": "A String", # Vendor-specific information such as Vendor ID.
},
"willAutoRenew": True or False, # Determines if the device will auto renew its support after the support end date. This is a read-only property.
}
projection: string, Determines whether the response contains the full list of properties or only a subset.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
FULL - Includes all metadata fields
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).
"activeTimeRanges": [ # A list of active time ranges (Read-only).
{
"activeTime": 42, # Duration of usage in milliseconds.
"date": "A String", # Date of usage
},
],
"annotatedAssetId": "A String", # The asset identifier as noted by an administrator or specified during enrollment.
"annotatedLocation": "A String", # The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.
"annotatedUser": "A String", # The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
"autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support. Please use "autoUpdateThrough" instead.
"autoUpdateThrough": "A String", # Output only. The timestamp after which the device will stop receiving Chrome updates or support.
"backlightInfo": [ # Output only. Contains backlight information for the device.
{ # Information about the device's backlights.
"brightness": 42, # Output only. Current brightness of the backlight, between 0 and max_brightness.
"maxBrightness": 42, # Output only. Maximum brightness for the backlight.
"path": "A String", # Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information.
},
],
"bootMode": "A 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](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).
"chromeOsType": "A String", # Output only. Chrome OS type of the device.
"cpuInfo": [ # Information regarding CPU specs in the device.
{ # CPU specs for a CPU.
"architecture": "A String", # The CPU architecture.
"logicalCpus": [ # Information for the Logical CPUs
{ # Status of a single logical CPU.
"cStates": [ # C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.
{ # Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.
"displayName": "A String", # Name of the state.
"sessionDuration": "A String", # Time spent in the state since the last reboot.
},
],
"currentScalingFrequencyKhz": 42, # Current frequency the CPU is running at.
"idleDuration": "A String", # Idle time since last boot.
"maxScalingFrequencyKhz": 42, # Maximum frequency the CPU is allowed to run at, by policy.
},
],
"maxClockSpeedKhz": 42, # The max CPU clock speed in kHz.
"model": "A String", # The CPU model name.
},
],
"cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only)
{
"cpuTemperatureInfo": [ # A list of CPU temperature samples.
{
"label": "A String", # CPU label
"temperature": 42, # Temperature in Celsius degrees.
},
],
"cpuUtilizationPercentageInfo": [
42,
],
"reportTime": "A String", # Date and time the report was received.
},
],
"deprovisionReason": "A String", # (Read-only) Deprovision reason.
"deviceFiles": [ # A list of device files to download (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"deviceId": "A String", # The unique ID of the Chrome device.
"deviceLicenseType": "A String", # Output only. Device license type.
"diskSpaceUsage": { # Represents a data capacity with some amount of current usage in bytes. # Output only. How much disk space the device has available and is currently using.
"capacityBytes": "A String", # Output only. The total capacity value, in bytes.
"usedBytes": "A String", # Output only. The current usage value, in bytes.
},
"diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes.
{
"volumeInfo": [ # Disk volumes
{
"storageFree": "A String", # Free disk space [in bytes]
"storageTotal": "A String", # Total disk space [in bytes]
"volumeId": "A String", # Volume id
},
],
},
],
"dockMacAddress": "A 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": "A String", # ETag of the resource.
"ethernetMacAddress": "A String", # The device's MAC address on the ethernet network interface.
"ethernetMacAddress0": "A 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.
"extendedSupportEligible": True or False, # Output only. Whether or not the device requires the extended support opt in.
"extendedSupportEnabled": True or False, # Output only. Whether extended support policy is enabled on the device.
"extendedSupportStart": "A String", # Output only. Date of the device when extended support policy for automatic updates starts.
"fanInfo": [ # Output only. Fan information for the device.
{ # Information about the device's fan.
"speedRpm": 42, # Output only. Fan speed in RPM.
},
],
"firmwareVersion": "A String", # The Chrome device's firmware version.
"firstEnrollmentTime": "A String", # Date and time for the first time the device was enrolled.
"kind": "admin#directory#chromeosdevice", # The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
"lastDeprovisionTimestamp": "A String", # (Read-only) Date and time for the last deprovision of the device.
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"lastKnownNetwork": [ # Contains last known network (Read-only)
{ # Information for an ip address.
"ipAddress": "A String", # The IP address.
"wanIpAddress": "A String", # The WAN IP address.
},
],
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response.
"manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format.
"meid": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).
"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response.
"notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.
"orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number.
"orgUnitId": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"orgUnitPath": "A 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](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"osUpdateStatus": { # Contains information regarding the current OS update status. # The status of the OS updates for the device.
"rebootTime": "A String", # Date and time of the last reboot.
"state": "A String", # The update state of an OS update.
"targetKioskAppVersion": "A String", # New required platform version from the pending updated kiosk app.
"targetOsVersion": "A String", # New platform version of the OS image being downloaded and applied. It is only set when update status is UPDATE_STATUS_DOWNLOAD_IN_PROGRESS or UPDATE_STATUS_NEED_REBOOT. Note this could be a dummy "0.0.0.0" for UPDATE_STATUS_NEED_REBOOT for some edge cases, e.g. update engine is restarted without a reboot.
"updateCheckTime": "A String", # Date and time of the last update check.
"updateTime": "A String", # Date and time of the last successful OS update.
},
"osVersion": "A String", # The Chrome device's operating system version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # A list of recent device users, in descending order, by last login time.
{ # A list of recent device users, in descending order, by last login time.
"email": "A String", # The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
"type": "A String", # The type of the user.
},
],
"screenshotFiles": [ # A list of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"serialNumber": "A 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": "A String", # The status of the device.
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only)
{
"reportTime": "A String", # Date and time the report was received.
"systemRamFreeInfo": [
"A String",
],
},
],
"systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only)
"tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only)
"family": "A 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
"firmwareVersion": "A String", # TPM firmware version.
"manufacturer": "A String", # TPM manufacturer code.
"specLevel": "A String", # TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.
"tpmModel": "A String", # TPM model number.
"vendorSpecific": "A String", # Vendor-specific information such as Vendor ID.
},
"willAutoRenew": True or False, # Determines if the device will auto renew its support after the support end date. This is a read-only property.
}