Method: partners.devices.claim

  • This endpoint claims a device for a customer, adding it to zero-touch enrollment, and returns an error if the device is already claimed by another customer.

  • The HTTP request to claim a device is a POST request to https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claim, requiring the reseller partner's ID in the path parameters.

  • The request body must include the deviceIdentifier, sectionType, and the customer's ID (customerId or googleWorkspaceCustomerId), along with optional fields such as deviceMetadata and preProvisioningToken for Chrome OS devices.

  • A successful response contains the deviceId of the claimed device and its resource name in the format partners/[PARTNER_ID]/devices/[DEVICE_ID].

  • This action requires the OAuth scope https://www.googleapis.com/auth/androidworkprovisioning for authorization.

Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error.

HTTP request

POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claim

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 
{
  "deviceIdentifier": {
    object (DeviceIdentifier)
  },
  "sectionType": enum (DeviceProvisioningSectionType),
  "deviceMetadata": {
    object (DeviceMetadata)
  },
  "preProvisioningToken": string,
  // Union field customer can be only one of the following:
  "customerId": string,
  "googleWorkspaceCustomerId": string
  // End of list of possible types for union field customer.
}
Fields
deviceIdentifier

object (DeviceIdentifier)

Required. Required. The device identifier of the device to claim.
sectionType

enum (DeviceProvisioningSectionType)

Required. The section type of the device's provisioning record.
deviceMetadata

object (DeviceMetadata)

Optional. The metadata to attach to the device.
preProvisioningToken

string

Optional. Must and can only be set for Chrome OS devices.
Union field customer. Required. The customer for whom the device is being claimed. customer can be only one of the following:
customerId

string (int64 format)

The ID of the customer for whom the device is being claimed.
googleWorkspaceCustomerId

string

The Google Workspace customer ID.

Response body

If successful, the response body contains data with the following structure:

Response message containing device id of the claim.

JSON representation 
{
  "deviceId": string,
  "deviceName": string
}
Fields
deviceId

string (int64 format)

The device ID of the claimed device.
deviceName

string

The resource name of the device in the format partners/[PARTNER_ID]/devices/[DEVICE_ID].

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/androidworkprovisioning

For more information, see the OAuth 2.0 Overview.