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 URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
customerId
|
The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the |
resourceId
|
The unique ID of the device. The |
Request body
The request body contains an instance of ChromeOsDeviceAction
.
Response body
If successful, the response is a generic HTTP response whose format is defined by the method.
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/admin.directory.device.chromeos
For more information, see the Authorization guide .
ChromeOsDeviceAction
Data about an update to the status of a Chrome OS device.
| JSON representation |
|---|
{ "action" : string , "deprovisionReason" : string } |
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.
