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.

Required Scalar Argument

• <partner-id> (string)
  • Required. The ID of the reseller partner.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

ClaimDeviceRequest:
  configuration-id: string
  customer-id: string
  device-identifier:
    chrome-os-attested-device-id: string
    device-type: string
    imei: string
    manufacturer: string
    meid: string
    model: string
    serial-number: string
  device-metadata:
    entries: { string: string }
  google-workspace-customer-id: string
  pre-provisioning-token: string
  section-type: string
  simlock-profile-id: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . configuration-id=dolor
  • Optional. The ID of the configuration applied to the device section.
• customer-id=et
  • The ID of the customer for whom the device is being claimed.
• device-identifier chrome-os-attested-device-id=et
  • An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices.
• device-type=sadipscing
  • The type of the device
• imei=stet
  • The device’s IMEI number. Validated on input.
• manufacturer=dolor
  • 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.
• meid=duo
  • The device’s MEID number.
• model=vero
  • The device model's name. Allowed values are listed in Android models and Chrome OS models.

• serial-number=vero

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

• ..device-metadata entries=key=invidunt

  • Metadata entries recorded as key-value pairs.
  • the value will be associated with the given key

• .. google-workspace-customer-id=stet

  • The Google Workspace customer ID.
• pre-provisioning-token=vero
  • Optional. Must and can only be set for Chrome OS devices.
• section-type=elitr
  • Required. The section type of the device's provisioning record.
• simlock-profile-id=lorem
  • Optional. Must and can only be set when DeviceProvisioningSectionType is SECTION_TYPE_SIM_LOCK. The unique identifier of the SimLock profile.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").