Method: partners.devices.claimAsync
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
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 \u003ccode\u003ePOST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claimAsync\u003c/code\u003e enables partners to asynchronously claim a batch of devices for a customer, adding them to zero-touch enrollment.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003epartnerId\u003c/code\u003e path parameter, which is the reseller partner's ID, and a request body with a list of device claims within the \u003ccode\u003eclaims\u003c/code\u003e field.\u003c/p\u003e\n"],["\u003cp\u003eEach device claim is identified by a \u003ccode\u003ePartnerClaim\u003c/code\u003e object, which contains the \u003ccode\u003edeviceIdentifier\u003c/code\u003e, \u003ccode\u003esectionType\u003c/code\u003e, \u003ccode\u003edeviceMetadata\u003c/code\u003e, and a customer identifier in the form of \u003ccode\u003ecustomerId\u003c/code\u003e or \u003ccode\u003egoogleWorkspaceCustomerId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePartnerClaim\u003c/code\u003e object optionally includes a \u003ccode\u003epreProvisioningToken\u003c/code\u003e and is required to complete the request.\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns an \u003ccode\u003eOperation\u003c/code\u003e object, indicating that the long-running operation has been initiated.\u003c/p\u003e\n"]]],["This outlines how to claim devices for a customer asynchronously via the Android zero-touch enrollment API. Use a `POST` request to `https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claimAsync`, providing the required `partnerId`. The request body, structured in JSON, includes a list of device `claims` with each claim containing the `deviceIdentifier`, `sectionType`, `deviceMetadata`, and the required customer's ID (`customerId` or `googleWorkspaceCustomerId`). The `preProvisioningToken` field is required only for ChromeOS devices. The response body contains an `Operation`.\n"],null,["# Method: partners.devices.claimAsync\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- [PartnerClaim](#PartnerClaim)\n - [JSON representation](#PartnerClaim.SCHEMA_REPRESENTATION)\n\nClaims a batch of devices for a customer asynchronously. Adds the devices to 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:claimAsync`\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| ``` { \"claims\": [ { object (/zero-touch/reference/reseller/rest/v1/partners.devices/claimAsync#PartnerClaim) } ] } ``` |\n\n| Fields ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `claims[]` | `object (`[PartnerClaim](/zero-touch/reference/reseller/rest/v1/partners.devices/claimAsync#PartnerClaim)`)` Required. A list of device claims. |\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\nPartnerClaim\n------------\n\nIdentifies one claim request.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"deviceIdentifier\": { object (/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceIdentifier) }, \"sectionType\": enum (/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceProvisioningSectionType), \"deviceMetadata\": { object (/zero-touch/reference/reseller/rest/v1/partners.devices#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`. } ``` |\n\n| Fields ||\n|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deviceIdentifier` | `object (`[DeviceIdentifier](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceIdentifier)`)` Required. Required. Device identifier of the device. |\n| `sectionType` | `enum (`[DeviceProvisioningSectionType](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceProvisioningSectionType)`)` Required. The section type of the device's provisioning record. |\n| `deviceMetadata` | `object (`[DeviceMetadata](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceMetadata)`)` Required. The metadata to attach to the device at claim. |\n| `preProvisioningToken` | `string` Optional. Must and can only be set for Chrome OS devices. |\n| Union field `customer`. Required. The customer for whom the device is being claimed. `customer` can be only one of the following: ||\n| `customerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the customer for whom the device is being claimed. |\n| `googleWorkspaceCustomerId` | `string` The Google Workspace customer ID. |"]]