Method: partners.devices.unclaimAsync
Stay organized with collections
Save and categorize content based on your preferences.
Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read Long‑running batch operations.
HTTP request
POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:unclaimAsync
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
partnerId |
string (int64 format)
Required. The reseller partner ID.
|
Request body
The request body contains data with the following structure:
| Fields |
unclaims[] |
object (PartnerUnclaim)
Required. The list of devices to unclaim.
|
Response body
If successful, the response body contains an instance of Operation.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidworkprovisioning
For more information, see the OAuth 2.0 Overview.
PartnerUnclaim
Identifies one unclaim request.
| JSON representation |
{
"sectionType": enum (DeviceProvisioningSectionType),
// Union field device can be only one of the following:
"deviceIdentifier": {
object (DeviceIdentifier)
},
"deviceId": string
// End of list of possible types for union field device.
} |
| Fields |
sectionType |
enum (DeviceProvisioningSectionType)
Required. The section type of the device's provisioning record.
|
Union field device. The device to unclaim. device can be only one of the following: |
deviceIdentifier |
object (DeviceIdentifier)
Required. Device identifier of the device.
|
deviceId |
string (int64 format)
Required. Device ID of the device.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-07 UTC.
[null,null,["Last updated 2024-08-07 UTC."],[[["\u003cp\u003eThis endpoint facilitates the asynchronous unclaiming of a batch of devices for a customer, effectively removing them from zero-touch enrollment.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request to unclaim devices is a \u003ccode\u003ePOST\u003c/code\u003e request to \u003ccode\u003ehttps://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:unclaimAsync\u003c/code\u003e, utilizing gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003epartnerId\u003c/code\u003e path parameter, representing the reseller partner ID, and the request body contains a list of \u003ccode\u003eunclaims\u003c/code\u003e, each specifying a device to be unclaimed.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePartnerUnclaim\u003c/code\u003e object uses a union field \u003ccode\u003edevice\u003c/code\u003e that accepts either a \u003ccode\u003edeviceIdentifier\u003c/code\u003e or a \u003ccode\u003edeviceId\u003c/code\u003e to specify which device should be unclaimed, along with the \u003ccode\u003esectionType\u003c/code\u003e of the device.\u003c/p\u003e\n"],["\u003cp\u003eThe endpoint requires the \u003ccode\u003ehttps://www.googleapis.com/auth/androidworkprovisioning\u003c/code\u003e OAuth scope and returns an instance of \u003ccode\u003eOperation\u003c/code\u003e upon successful completion.\u003c/p\u003e\n"]]],["This describes how to unclaim devices from zero-touch enrollment asynchronously via a `POST` request to `https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:unclaimAsync`. The request requires a `partnerId` path parameter and a JSON body containing an array of `unclaims`. Each unclaim specifies a device by either `deviceIdentifier` or `deviceId`, and its `sectionType`. Successful requests return an `Operation`. Authorization needs the `https://www.googleapis.com/auth/androidworkprovisioning` OAuth scope.\n"],null,["# Method: partners.devices.unclaimAsync\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n- [PartnerUnclaim](#PartnerUnclaim)\n - [JSON representation](#PartnerUnclaim.SCHEMA_REPRESENTATION)\n\nUnclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).\n\n### HTTP request\n\n`POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:unclaimAsync`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------|\n| `partnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The reseller partner ID. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"unclaims\": [ { object (/zero-touch/reference/reseller/rest/v1/partners.devices/unclaimAsync#PartnerUnclaim) } ] } ``` |\n\n| Fields ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `unclaims[]` | `object (`[PartnerUnclaim](/zero-touch/reference/reseller/rest/v1/partners.devices/unclaimAsync#PartnerUnclaim)`)` Required. The list of devices to unclaim. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/zero-touch/reference/reseller/rest/v1/operations#Operation).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidworkprovisioning`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nPartnerUnclaim\n--------------\n\nIdentifies one unclaim request.\n\n| JSON representation ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"sectionType\": enum (/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceProvisioningSectionType), // Union field `device` can be only one of the following: \"deviceIdentifier\": { object (/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceIdentifier) }, \"deviceId\": string // End of list of possible types for union field `device`. } ``` |\n\n| Fields ||\n|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| `sectionType` | `enum (`[DeviceProvisioningSectionType](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceProvisioningSectionType)`)` Required. The section type of the device's provisioning record. |\n| Union field `device`. The device to unclaim. `device` can be only one of the following: |||\n| `deviceIdentifier` | `object (`[DeviceIdentifier](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceIdentifier)`)` Required. Device identifier of the device. |\n| `deviceId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. Device ID of the device. |"]]