Use BatchChangeChromeOsDeviceStatus instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices.
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.
HTTP request
POST https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
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.
resourceId
string
The unique ID of the device. The resourceIds are returned in the response from the chromeosdevices.list method.
Data about an update to the status of a Chrome OS device.
JSON representation
{"action": string,"deprovisionReason": string}
Fields
action
string
chromeosdevices.action to be taken on the Chrome OS device.
Acceptable values are:
deprovision: Remove a device from management that is no longer active, being resold, or is being submitted for return / repair, use the deprovision action to dissociate it from management.
disable: If you believe a device in your organization has been lost or stolen, you can disable the device so that no one else can use it. When a device is disabled, all the user can see when turning on the Chrome device is a screen telling them that it’s been disabled, and your desired contact information of where to return the device.
reenable: Re-enable a disabled device when a misplaced device is found or a lost device is returned. You can also use this feature if you accidentally mark a Chrome device as disabled.
pre_provisioned_disable: A pre-provisioned device that cannot enroll. An admin can re-enable the device to allow Zero-Touch Enrollment by changing the status to "pre_provisioned_reenable". Note: From this state the device can be deprovisioned.
pre_provisioned_reenable: Device is pre-provisioned by OEMs. Devices in this state are eligible for Zero-Touch Enrollment.
deprovisionReason
string
Only used when the action is deprovision. With the deprovision action, this field is required.
Acceptable values are:
different_model_replacement: Use if you're upgrading or replacing your device with a newer model of the same device.
retiring_device: Use if you're reselling, donating, or permanently removing the device from use.
same_model_replacement: Use if a hardware issue was encountered on a device and it is being replaced with the same model or a like-model replacement from a repair vendor / manufacturer.
upgrade_transfer: Use if you're replacing your Cloud Ready devices with Chromebooks within one year.
[null,null,["Last updated 2024-08-22 UTC."],[[["This API (`customer.devices.chromeos/action`) is deprecated and `BatchChangeChromeOsDeviceStatus` should be used instead."],["It allows administrators to manage the status of Chrome OS devices, including deprovisioning, disabling, and re-enabling."],["Deprovisioning removes device management, disabling prevents usage (ideal for lost/stolen devices), and re-enabling restores device access."],["Before re-enrollment, deprovisioned devices require wiping, and re-enabling a device consumes a device license."]]],["This document details actions for managing Chrome OS devices, specifically through a deprecated method (use `BatchChangeChromeOsDeviceStatus` instead). Actions include: `deprovision` (removing a device, requiring a wipe for re-enrollment), `disable` (for lost/stolen devices), and `reenable` (re-enabling disabled devices, consuming a license). `pre_provisioned_disable` and `pre_provisioned_reenable` are available to control Zero-Touch Enrollment. Deprovisioning requires a reason: `different_model_replacement`, `retiring_device`, `same_model_replacement`, `upgrade_transfer`. The request requires a customer and device ID, with specific authorization scope.\n"]]
