Google

Android Device Provisioning Partner API

Automates Android zero-touch enrollment for device resellers, customers, and EMMs.

IoT & devices#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Automates Android zero-touch enrollment for device resellers, customers, and EMMs.

Endpoints 24

customers

  • GETLists the user's customer accounts./v1/customers?pageSize=0&pageToken=stringLists the user's customer accounts.

customers.configurations

  • GETLists a customer's configurations./v1/:parent/configurationsLists a customer's configurations.
  • POSTCreates a new configuration/v1/:parent/configurationsCreates a new configuration. Once created, a customer can apply the configuration to devices.
  • DELETEDeletes an unused configuration/v1/:nameDeletes an unused configuration. The API call fails if the customer has devices with the configuration applied.
  • PATCHUpdates a configuration's field values./v1/:name?updateMask=stringUpdates a configuration's field values.

partners.devices

  • GETGets a device./v1/:nameGets a device.
  • POSTClaims a device for a customer and adds it to zero-touch enrollment/v1/partners/:partnerId/devices:claimClaims 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.
  • POSTClaims a batch of devices for a customer asynchronously/v1/partners/:partnerId/devices:claimAsyncClaims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read Long‑running batch operations.
  • POSTFinds devices by hardware identifiers, such as IMEI./v1/partners/:partnerId/devices:findByIdentifierFinds devices by hardware identifiers, such as IMEI.
  • POSTFinds devices claimed for customers/v1/partners/:partnerId/devices:findByOwnerFinds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the partnerId argument. The customer's…
  • POSTGets a device's SIM lock state./v1/partners/:partnerId/devices:getSimLockStateGets a device's SIM lock state.
  • POSTUpdates reseller metadata associated with the device/v1/partners/:metadataOwnerId/devices/:deviceId/metadataUpdates reseller metadata associated with the device. Android devices only.
  • POSTUnclaims a device from a customer and removes it from zero-touch enrollment./v1/partners/:partnerId/devices:unclaimUnclaims a device from a customer and removes it from zero-touch enrollment.
  • POSTUnclaims a batch of devices for a customer asynchronously/v1/partners/:partnerId/devices:unclaimAsyncUnclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read Long‑running batch operations.
  • POSTUpdates the reseller metadata attached to a batch of devices/v1/partners/:partnerId/devices:updateMetadataAsyncUpdates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an Operation that can be used to track…

customers.devices

  • POSTApplies a Configuration to the device to register the device for zero-touch enrollment/v1/:parent/devices:applyConfigurationApplies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically…
  • GETLists a customer's devices./v1/:parent/devices?pageSize=string&pageToken=stringLists a customer's devices.
  • POSTRemoves a configuration from device./v1/:parent/devices:removeConfigurationRemoves a configuration from device.
  • POSTUnclaims a device from a customer and removes it from zero-touch enrollment/v1/:parent/devices:unclaimUnclaims a device from a customer and removes it from zero-touch enrollment. After removing a device, a customer must contact their reseller to register the…

customers.dpcs

  • GETLists the DPCs (device policy controllers) that support zero-touch enrollment./v1/:parent/dpcsLists the DPCs (device policy controllers) that support zero-touch enrollment.

partners.vendors.customers

  • GETLists the customers of the vendor./v1/:parent/customers?pageSize=0&pageToken=stringLists the customers of the vendor.

partners.customers

  • POSTCreates a customer for zero-touch enrollment/v1/:parent/customersCreates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API…
  • GETLists the customers that are enrolled to the reseller identified by the `partnerId` argument/v1/partners/:partnerId/customers?pageSize=0&pageToken=stringLists the customers that are enrolled to the reseller identified by the partnerId argument. This list includes customers that the reseller created and…

partners.vendors

  • GETLists the vendors of the partner./v1/:parent/vendors?pageSize=0&pageToken=stringLists the vendors of the partner.

API details

Base URL
https://androiddeviceprovisioning.googleapis.com
Authentication
OAuth 2.0 (authorization code flow)
An API key in the key query parameter
Operations
24 operations on 20 pathsPOST 14GET 8PATCH 1DELETE 1
Main resources
partners.devices 10customers.configurations 4customers.devices 4partners.customers 2customers 1customers.dpcs 1partners.vendors 1partners.vendors.customers 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Android Device Provisioning Partner API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Android Device Provisioning Partner API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Lists the user's customer accounts.” (GET /v1/customers?pageSize=0&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Android Device Provisioning Partner API?

Automates Android zero-touch enrollment for device resellers, customers, and EMMs. It is listed under IoT & devices and has 24 endpoints.

Who publishes the Android Device Provisioning Partner API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Android Device Provisioning Partner API?

Requests go to https://androiddeviceprovisioning.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Android Device Provisioning Partner API?

It accepts 2 methods: OAuth 2.0 (authorization code flow); an API key in the key query parameter.

How many endpoints does the Android Device Provisioning Partner API have?

24 operations on 20 paths (14 POST, 8 GET, 1 PATCH, 1 DELETE). The largest groups are partners.devices, customers.configurations, customers.devices, partners.customers.

Is forking the Android Device Provisioning Partner API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.