Claim

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

12 variables
2 variables

Claims 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

Input

This building block consumes 12 input parameters

  = Parameter name
  = Format

partnerId INTEGER Required

Required. The ID of the reseller partner

deviceIdentifier OBJECT

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

deviceIdentifier.imei STRING

The device’s IMEI number. Validated on input

deviceIdentifier.meid STRING

The device’s MEID number

deviceIdentifier.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

deviceIdentifier.serialNumber STRING

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

deviceIdentifier.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

deviceMetadata OBJECT

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

deviceMetadata.entries OBJECT

Metadata entries recorded as key-value pairs

deviceMetadata.entries.customKey.value STRING Required

Metadata entries recorded as key-value pairs

sectionType ENUMERATION

Required. The section type of the device's provisioning record

customerId INTEGER

Required. The ID of the customer for whom the device is being claimed

Output

This building block provides 2 output parameters

  = Parameter name
  = Format

deviceName STRING

The resource name of the device in the format partners/[PARTNER_ID]/devices/[DEVICE_ID]

deviceId INTEGER

The device ID of the claimed device