Chromeosdevices: action

Requires authorization

Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. Try it now.

Request

HTTP request

POST https://www.googleapis.com/admin/directory/v1/customer/customerId/devices/chromeos/deviceId/action

Parameters

Parameter name Value Description
Path parameters
customerId string The unique ID for the customer's G Suite 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.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/admin.directory.device.chromeos

Request body

In the request body, supply data with the following structure:

{
  "action": string, // required
  "deprovisionReason": string // required for deprovision action only
}
Property name Value Description Notes
action string 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.
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.

Response

Error Codes

HTTP Response Code

Meaning

Sent when

412

Precondition failed


“Insufficient licenses”

This error is sent if a device is attempted to be re-enabled when there are no available licenses to consume. An available license must exist for each device you re-enable.

412

Precondition failed


“Illegal device state transition”

This error is sent if a device action is being performed against a device that is in a different state than needed for the action.

For example, attempting to re-enable a device that is deprovisioned or attempting to disable a deprovisioned device will result in this error.


If successful, this method returns an empty response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Enviar comentarios sobre…

¿Necesitas ayuda? Visita nuestra página de asistencia.