Android Device Provisioning Partner API

  • This API empowers device resellers to manage zero-touch enrollment programmatically.

  • The API's resources include operations, partners' customers, partners' devices, partners' vendors, and partners' vendors' customers, enabling management of various aspects of the enrollment process.

  • The API service endpoint is https://androiddeviceprovisioning.googleapis.com, and all resource URIs are relative to this address.

  • The API supports multiple methods like creating, listing, claiming, unclaiming, and finding devices or customers, all tailored for managing zero-touch enrollment.

  • This API offers a machine-readable specification for describing REST APIs, for building client libraries and other tools using the provided discovery document.

This API lets device resellers programmatically manage zero-touch enrollment.

Service: androiddeviceprovisioning.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://androiddeviceprovisioning.googleapis.com

REST Resource: v1.operations

Methods
get GET /v1/{name=operations/**}
Gets the latest state of a long-running operation.

REST Resource: v1.partners.customers

Methods
create POST /v1/{parent=partners/*}/customers
Creates a customer for zero-touch enrollment.
list GET /v1/partners/{partnerId}/customers
Lists the customers that are enrolled to the reseller identified by the partnerId argument.

REST Resource: v1.partners.devices

Methods
claim POST /v1/partners/{partnerId}/devices:claim
Claims a device for a customer and adds it to zero-touch enrollment.
claimAsync POST /v1/partners/{partnerId}/devices:claimAsync
Claims a batch of devices for a customer asynchronously.
findByIdentifier POST /v1/partners/{partnerId}/devices:findByIdentifier
Finds devices by hardware identifiers, such as IMEI.
findByOwner POST /v1/partners/{partnerId}/devices:findByOwner
Finds devices claimed for customers.
get GET /v1/{name=partners/*/devices/*}
Gets a device.
metadata POST /v1/partners/{metadataOwnerId}/devices/{deviceId}/metadata
Updates reseller metadata associated with the device.
unclaim POST /v1/partners/{partnerId}/devices:unclaim
Unclaims a device from a customer and removes it from zero-touch enrollment.
unclaimAsync POST /v1/partners/{partnerId}/devices:unclaimAsync
Unclaims a batch of devices for a customer asynchronously.
updateMetadataAsync POST /v1/partners/{partnerId}/devices:updateMetadataAsync
Updates the reseller metadata attached to a batch of devices.

REST Resource: v1.partners.vendors

Methods
list GET /v1/{parent=partners/*}/vendors
Lists the vendors of the partner.

REST Resource: v1.partners.vendors.customers

Methods
list GET /v1/{parent=partners/*/vendors/*}/customers
Lists the customers of the vendor.