Method: devices.wipe

Wipes all data on the specified device.

HTTP request

POST https://cloudidentity.googleapis.com/v1/{name=devices/*}:wipe

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name of the Device in format: devices/{device}/deviceUsers/{deviceUser}, where device is the unique ID assigned to the Device, and deviceUser is the unique ID assigned to the User.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "customer": string,
  "removeResetLock": boolean
}
Fields
customer

string

Optional. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer}, where customer is the customer to whom the device belongs.
removeResetLock

boolean

Optional. Specifies if a user is able to factory reset a device after a Device Wipe. On iOS, this is called "Activation Lock", while on Android, this is known as "Factory Reset Protection". If true, this protection will be removed from the device, so that a user can successfully factory reset. If false, the setting is untouched on the device.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-identity.devices
  • https://www.googleapis.com/auth/cloud-identity

For more information, see the Authentication Overview.