Method: partners.devices.claimAsync

  • This endpoint POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claimAsync enables partners to asynchronously claim a batch of devices for a customer, adding them to zero-touch enrollment.

  • The request requires a partnerId path parameter, which is the reseller partner's ID, and a request body with a list of device claims within the claims field.

  • Each device claim is identified by a PartnerClaim object, which contains the deviceIdentifier, sectionType, deviceMetadata, and a customer identifier in the form of customerId or googleWorkspaceCustomerId.

  • The PartnerClaim object optionally includes a preProvisioningToken and is required to complete the request.

  • A successful request returns an Operation object, indicating that the long-running operation has been initiated.

Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read Long‑running batch operations.

HTTP request

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

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 
{
  "claims": [
    {
      object (PartnerClaim)
    }
  ]
}
Fields
claims[]

object (PartnerClaim)

Required. A list of device claims.

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.

PartnerClaim

Identifies one claim request.

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. Device identifier of the device.
sectionType

enum (DeviceProvisioningSectionType)

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

object (DeviceMetadata)

Required. The metadata to attach to the device at claim.
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.