REST Resource: customers.devices

  • This content outlines the structure and fields for managing Android and Chrome OS devices registered for zero-touch enrollment, including device identification, metadata, and claims.

  • DeviceIdentifier is used to encapsulate hardware and product IDs for identifying a device, which includes fields like serialNumber, manufacturer, model, and various IMEI or MEID numbers, for single and dual sim devices.

  • DeviceMetadata allows for attaching custom key-value pair information to devices, enabling flexible data association with each device.

  • DeviceClaim records a reseller's claim on a device for a customer, with SECTION_TYPE_ZERO_TOUCH indicating devices claimed for zero-touch enrollment.

  • The available methods include managing a device's configuration, getting the details for a specific device, getting a list of devices, and removing or unclaiming them.

Resource: Device

An Android or Chrome OS device registered for zero-touch enrollment.

JSON representation 
{
  "deviceId": string,
  "deviceIdentifier": {
    object (DeviceIdentifier)
  },
  "name": string,
  "deviceMetadata": {
    object (DeviceMetadata)
  },
  "claims": [
    {
      object (DeviceClaim)
    }
  ],
  "configuration": string
}
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 customers/[CUSTOMER_ID]/devices/[DEVICE_ID]. Assigned by the server.
deviceMetadata

object (DeviceMetadata)

The metadata attached to the device. Structured as key-value pairs.
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 customers.devices.unclaim to remove the device from zero-touch enrollment.
configuration

string

The configuration applied to the device in the format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. The value is null if the device doesn't have a configuration applied.

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,
  "deviceType": enum (DeviceType),
  "chromeOsAttestedDeviceId": 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.

  // Union field hardware_id2 can be only one of the following:
  "imei2": string,
  "meid2": string
  // End of list of possible types for union field hardware_id2.
}
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 Android manufacturers.
model

string

The device model's name. Allowed values are listed in Android models and Chrome OS models.
deviceType

enum (DeviceType)

The type of the device
chromeOsAttestedDeviceId

string

An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices.
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.
Union field hardware_id2. The second hardware ID, for dual-SIM devices. If set, it must be the same identifier type as the first hardware ID. hardware_id2 can be only one of the following:
imei2

string

The device’s second IMEI number.
meid2

string

The device’s second MEID number.

DeviceType

The operating system of the device.

Enums
DEVICE_TYPE_ANDROID Android device
DEVICE_TYPE_CHROME_OS Chrome OS device

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,
  "googleWorkspaceCustomerId": string,
  "additionalService": enum (AdditionalService)
}
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.
googleWorkspaceCustomerId

string

The ID of the Google Workspace account that owns the Chrome OS device.
additionalService

enum (AdditionalService)

The Additional service registered for 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.

AdditionalService

Additional service registered for the device.

Enums
DEVICE_PROTECTION Device protection service, also known as Android Enterprise Essentials. To claim a device with the device protection service you must enroll with the partnership team.

Methods

applyConfiguration

 Applies a Configuration to the device to register the device for zero-touch enrollment.

get

 Gets the details of a device.

list

 Lists a customer's devices.

removeConfiguration

 Removes a configuration from device.

unclaim

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