Method: partners.devices.unclaim
Stay organized with collections
Save and categorize content based on your preferences.
Unclaims a device from a customer and removes it from zero-touch enrollment.
HTTP request
POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:unclaim
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
partnerId |
string (int64 format)
Required. The ID of the reseller partner.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"sectionType": enum (DeviceProvisioningSectionType),
// Union field device_to_unclaim can be only one of the following:
"deviceId": string,
"deviceIdentifier": {
object (DeviceIdentifier)
}
// End of list of possible types for union field device_to_unclaim.
} |
| Fields |
sectionType |
enum (DeviceProvisioningSectionType)
Required. The section type of the device's provisioning record.
|
Union field device_to_unclaim. Required. The device to unclaim. device_to_unclaim can be only one of the following: |
deviceId |
string (int64 format)
Required. The device ID returned by devices.claim.
|
deviceIdentifier |
object (DeviceIdentifier)
Required. The device identifier you used when you claimed this device.
|
Response body
If successful, the response body is empty.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidworkprovisioning
For more information, see the OAuth 2.0 Overview.
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 API endpoint allows partners to unclaim a device from a customer, removing it from zero-touch enrollment using a POST request.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003epartnerId\u003c/code\u003e path parameter, which is the unique identifier for the reseller partner, and it must be specified in the URL.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must specify either the \u003ccode\u003edeviceId\u003c/code\u003e or a \u003ccode\u003edeviceIdentifier\u003c/code\u003e along with a \u003ccode\u003esectionType\u003c/code\u003e to identify the device being unclaimed.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests will result in an empty response body, indicating the device has been unclaimed.\u003c/p\u003e\n"],["\u003cp\u003eThe API call needs the \u003ccode\u003ehttps://www.googleapis.com/auth/androidworkprovisioning\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This document details the process to unclaim a device from a customer, removing it from zero-touch enrollment. It uses a `POST` HTTP request to the endpoint: `https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:unclaim`, requires the `partnerId` path parameter and the `https://www.googleapis.com/auth/androidworkprovisioning` OAuth scope. The request body requires a `sectionType`, along with either a `deviceId` or a `deviceIdentifier` to specify the device to unclaim. A successful request returns an empty response body.\n"],null,["# Method: partners.devices.unclaim\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\nUnclaims a device from a customer and removes it from zero-touch enrollment.\n\n### HTTP request\n\n`POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:unclaim`\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 ID of the reseller partner. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"sectionType\": enum (/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceProvisioningSectionType), // Union field `device_to_unclaim` can be only one of the following: \"deviceId\": string, \"deviceIdentifier\": { object (/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceIdentifier) } // End of list of possible types for union field `device_to_unclaim`. } ``` |\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_to_unclaim`. Required. The device to unclaim. `device_to_unclaim` can be only one of the following: |||\n| `deviceId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The device ID returned by `devices.claim`. |\n| `deviceIdentifier` | `object (`[DeviceIdentifier](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceIdentifier)`)` Required. The device identifier you used when you claimed this device. |\n\n### Response body\n\nIf successful, the response body is empty.\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)."]]