Required.Resource nameof 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 nameof the customer. If you're using this API for your own organization, usecustomers/my_customerIf you're using this API to manage another organization, usecustomers/{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 ofOperation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThis API endpoint, \u003ccode\u003ePOST https://cloudidentity.googleapis.com/v1/{name=devices/*}:wipe\u003c/code\u003e, is used to wipe all data on a specified device.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e parameter is required and represents the resource name of the device, following the format \u003ccode\u003edevices/{device}/deviceUsers/{deviceUser}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body optionally includes a \u003ccode\u003ecustomer\u003c/code\u003e field for specifying the customer associated with the device and a \u003ccode\u003eremoveResetLock\u003c/code\u003e boolean to determine if factory reset protection should be removed.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests return an \u003ccode\u003eOperation\u003c/code\u003e instance in the response body.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires one of the following OAuth scopes: \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-identity.devices\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-identity\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: devices.wipe\n\nWipes all data on the specified device.\n\n### HTTP request\n\n`POST https://cloudidentity.googleapis.com/v1/{name=devices/*}:wipe`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/identity/docs/reference/rest/Shared.Types/Operation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-identity.devices`\n- `https://www.googleapis.com/auth/cloud-identity`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
