Home Guides Reference Support

REST Resource: partners.devices

Resource: Device

An Android device registered for zero-touch enrollment.

JSON representation 
{
  "deviceId": string,
  "deviceIdentifier": {
    object(DeviceIdentifier)
  },
  "name": string,
  "deviceMetadata": {
    object(DeviceMetadata)
  },
  "claims": [
    {
      object(DeviceClaim)
    }
  ]
}
Fields
deviceId

string (int64 format)

Output only. The ID of the device. Assigned by the server.

deviceIdentifier

object(DeviceIdentifier)

The hardware IDs that identify a manufactured device. To learn more, read Identifiers.

name

string

Output only. The API resource name in the format partners/[PARTNER_ID]/devices/[DEVICE_ID]. Assigned by the server.

deviceMetadata

object(DeviceMetadata)

The metadata attached to the device. Structured as key-value pairs. To learn more, read Device metadata.

claims[]

object(DeviceClaim)

Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type SECTION_TYPE_ZERO_TOUCH. Call partners.devices.unclaim or partners.devices.unclaimAsync to remove the device from zero-touch enrollment.

DeviceIdentifier

Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read Identifiers.

JSON representation 
{
  "serialNumber": string,
  "manufacturer": string,
  "model": string,

  // Union field hardware_id can be only one of the following:
  "imei": string,
  "meid": string
  // End of list of possible types for union field hardware_id.
}
Fields
serialNumber

string

The manufacturer's serial number for the device. This value might not be unique across different device models.

manufacturer

string

The device manufacturer’s name. Matches the device's built-in value returned from android.os.Build.MANUFACTURER. Allowed values are listed in manufacturers.

model

string

The device model's name. Matches the device's built-in value returned from android.os.Build.MODEL. Allowed values are listed in models.

Union field hardware_id. Hardware ID based on a modem ID. hardware_id can be only one of the following:
imei

string

The device’s IMEI number. Validated on input.

meid

string

The device’s MEID number.

DeviceMetadata

Metadata entries that can be attached to a Device. To learn more, read Device metadata.

JSON representation 
{
  "entries": {
    string: string,
    ...
  }
}
Fields
entries

map (key: string, value: string)

Metadata entries recorded as key-value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

DeviceClaim

A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type SECTION_TYPE_ZERO_TOUCH. To learn more, read Claim devices for customers.

JSON representation 
{
  "sectionType": enum(DeviceProvisioningSectionType),
  "ownerCompanyId": string,
  "resellerId": string
}
Fields
sectionType

enum(DeviceProvisioningSectionType)

Output only. The type of claim made on the device.

ownerCompanyId

string (int64 format)

The ID of the Customer that purchased the device.

resellerId

string (int64 format)

The ID of the reseller that claimed the device.

DeviceProvisioningSectionType

The section type of a provisioning record.

Enums
SECTION_TYPE_SIM_LOCK SIM-lock section type.
SECTION_TYPE_ZERO_TOUCH Zero-touch enrollment section type.

Methods

claim

 Claims a device for a customer and adds it to zero-touch enrollment.

claimAsync

 Claims a batch of devices for a customer asynchronously.

findByIdentifier

 Finds devices by hardware identifiers, such as IMEI.

findByOwner

 Finds devices claimed for customers.

get

 Gets a device.

metadata

 Updates reseller metadata associated with the device.

unclaim

 Unclaims a device from a customer and removes it from zero-touch enrollment.

unclaimAsync

 Unclaims a batch of devices for a customer asynchronously.

updateMetadataAsync

 Updates the reseller metadata attached to a batch of devices.