Method: partners.devices.unclaim

  • This API endpoint allows partners to unclaim a device from a customer, removing it from zero-touch enrollment using a POST request.

  • The request requires a partnerId path parameter, which is the unique identifier for the reseller partner, and it must be specified in the URL.

  • The request body must specify either the deviceId or a deviceIdentifier along with a sectionType to identify the device being unclaimed.

  • Successful requests will result in an empty response body, indicating the device has been unclaimed.

  • The API call needs the https://www.googleapis.com/auth/androidworkprovisioning OAuth scope for authorization.

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.