blob: 3daa94121e3dad10d6f7920d7d1f5854cac1f551 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="androiddeviceprovisioning_v1.html">Android Device Provisioning Partner API</a> . <a href="androiddeviceprovisioning_v1.customers.html">customers</a> . <a href="androiddeviceprovisioning_v1.customers.devices.html">devices</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#applyConfiguration">applyConfiguration(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070079<p class="firstline">Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset.</p>
80<p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070083<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the details of a device.</p>
86<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080087 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Lists a customer's devices.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#removeConfiguration">removeConfiguration(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Removes a configuration from device.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#unclaim">unclaim(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097<p class="firstline">Unclaims 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 device into zero-touch enrollment again.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098<h3>Method Details</h3>
99<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700100 <code class="details" id="applyConfiguration">applyConfiguration(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700101 <pre>Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700102
103Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700104 parent: string, Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700105 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106 The object takes the form of:
107
108{ # Request message for customer to assign a configuration to device.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800109 &quot;configuration&quot;: &quot;A String&quot;, # Required. The configuration applied to the device in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700110 &quot;device&quot;: { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it&#x27;s more flexible for the caller. To learn more about device identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device the configuration is applied to.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800111 &quot;deviceId&quot;: &quot;A String&quot;, # The ID of the device.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700112 &quot;deviceIdentifier&quot;: { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs of the device.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800113 &quot;serialNumber&quot;: &quot;A String&quot;, # The manufacturer&#x27;s serial number for the device. This value might not be unique across different device models.
114 &quot;meid&quot;: &quot;A String&quot;, # The device’s MEID number.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800115 &quot;manufacturer&quot;: &quot;A String&quot;, # The device manufacturer’s name. Matches the device&#x27;s built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
116 &quot;imei&quot;: &quot;A String&quot;, # The device’s IMEI number. Validated on input.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800117 &quot;model&quot;: &quot;A String&quot;, # The device model&#x27;s name. Matches the device&#x27;s built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700118 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700119 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120 }
121
122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
126
127Returns:
128 An object of the form:
129
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700130 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700131 }</pre>
132</div>
133
134<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700135 <code class="details" id="close">close()</code>
136 <pre>Close httplib2 connections.</pre>
137</div>
138
139<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700140 <code class="details" id="get">get(name, x__xgafv=None)</code>
141 <pre>Gets the details of a device.
142
143Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700144 name: string, Required. The device to get. An API resource name in the format `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
149
150Returns:
151 An object of the form:
152
153 { # An Android device registered for zero-touch enrollment.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800154 &quot;claims&quot;: [ # 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.
155 { # 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](/zero-touch/guides/how-it-works#claim).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800156 &quot;resellerId&quot;: &quot;A String&quot;, # The ID of the reseller that claimed the device.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800157 &quot;sectionType&quot;: &quot;A String&quot;, # Output only. The type of claim made on the device.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800158 &quot;vacationModeStartTime&quot;: &quot;A String&quot;, # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in &#x27;vacation mode&#x27;.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800159 &quot;ownerCompanyId&quot;: &quot;A String&quot;, # The ID of the Customer that purchased the device.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800160 &quot;vacationModeExpireTime&quot;: &quot;A String&quot;, # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in &#x27;vacation mode&#x27;.
161 },
162 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800163 &quot;configuration&quot;: &quot;A String&quot;, # Not available to resellers.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700164 &quot;deviceMetadata&quot;: { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
Bu Sun Kim65020912020-05-20 12:08:20 -0700165 &quot;entries&quot;: { # Metadata entries recorded as key-value pairs.
166 &quot;a_key&quot;: &quot;A String&quot;,
167 },
168 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800169 &quot;deviceIdentifier&quot;: { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
170 &quot;serialNumber&quot;: &quot;A String&quot;, # The manufacturer&#x27;s serial number for the device. This value might not be unique across different device models.
171 &quot;meid&quot;: &quot;A String&quot;, # The device’s MEID number.
172 &quot;manufacturer&quot;: &quot;A String&quot;, # The device manufacturer’s name. Matches the device&#x27;s built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
173 &quot;imei&quot;: &quot;A String&quot;, # The device’s IMEI number. Validated on input.
174 &quot;model&quot;: &quot;A String&quot;, # The device model&#x27;s name. Matches the device&#x27;s built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
175 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700176 &quot;deviceId&quot;: &quot;A String&quot;, # Output only. The ID of the device. Assigned by the server.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800177 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700178 }</pre>
179</div>
180
181<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800182 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700183 <pre>Lists a customer&#x27;s devices.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700184
185Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700186 parent: string, Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`. (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800187 pageToken: string, A token specifying which result page to return.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800188 pageSize: string, The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700189 x__xgafv: string, V1 error format.
190 Allowed values
191 1 - v1 error format
192 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700193
194Returns:
195 An object of the form:
196
Bu Sun Kim65020912020-05-20 12:08:20 -0700197 { # Response message of customer&#x27;s liting devices.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800198 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token used to access the next page of results. Omitted if no further results are available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700199 &quot;devices&quot;: [ # The customer&#x27;s devices.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700200 { # An Android device registered for zero-touch enrollment.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800201 &quot;claims&quot;: [ # 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.
202 { # 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](/zero-touch/guides/how-it-works#claim).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800203 &quot;resellerId&quot;: &quot;A String&quot;, # The ID of the reseller that claimed the device.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800204 &quot;sectionType&quot;: &quot;A String&quot;, # Output only. The type of claim made on the device.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800205 &quot;vacationModeStartTime&quot;: &quot;A String&quot;, # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in &#x27;vacation mode&#x27;.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800206 &quot;ownerCompanyId&quot;: &quot;A String&quot;, # The ID of the Customer that purchased the device.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800207 &quot;vacationModeExpireTime&quot;: &quot;A String&quot;, # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in &#x27;vacation mode&#x27;.
208 },
209 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800210 &quot;configuration&quot;: &quot;A String&quot;, # Not available to resellers.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700211 &quot;deviceMetadata&quot;: { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
Bu Sun Kim65020912020-05-20 12:08:20 -0700212 &quot;entries&quot;: { # Metadata entries recorded as key-value pairs.
213 &quot;a_key&quot;: &quot;A String&quot;,
214 },
215 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800216 &quot;deviceIdentifier&quot;: { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
217 &quot;serialNumber&quot;: &quot;A String&quot;, # The manufacturer&#x27;s serial number for the device. This value might not be unique across different device models.
218 &quot;meid&quot;: &quot;A String&quot;, # The device’s MEID number.
219 &quot;manufacturer&quot;: &quot;A String&quot;, # The device manufacturer’s name. Matches the device&#x27;s built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
220 &quot;imei&quot;: &quot;A String&quot;, # The device’s IMEI number. Validated on input.
221 &quot;model&quot;: &quot;A String&quot;, # The device model&#x27;s name. Matches the device&#x27;s built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
222 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700223 &quot;deviceId&quot;: &quot;A String&quot;, # Output only. The ID of the device. Assigned by the server.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800224 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700225 },
226 ],
227 }</pre>
228</div>
229
230<div class="method">
231 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
232 <pre>Retrieves the next page of results.
233
234Args:
235 previous_request: The request for the previous page. (required)
236 previous_response: The response from the request for the previous page. (required)
237
238Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700239 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700240 page. Returns None if there are no more items in the collection.
241 </pre>
242</div>
243
244<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700245 <code class="details" id="removeConfiguration">removeConfiguration(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700246 <pre>Removes a configuration from device.
247
248Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700249 parent: string, Required. The customer managing the device in the format `customers/[CUSTOMER_ID]`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700250 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700251 The object takes the form of:
252
253{ # Request message for customer to remove the configuration from device.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700254 &quot;device&quot;: { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it&#x27;s more flexible for the caller. To learn more about device identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device to remove the configuration from.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800255 &quot;deviceId&quot;: &quot;A String&quot;, # The ID of the device.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700256 &quot;deviceIdentifier&quot;: { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs of the device.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800257 &quot;serialNumber&quot;: &quot;A String&quot;, # The manufacturer&#x27;s serial number for the device. This value might not be unique across different device models.
258 &quot;meid&quot;: &quot;A String&quot;, # The device’s MEID number.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800259 &quot;manufacturer&quot;: &quot;A String&quot;, # The device manufacturer’s name. Matches the device&#x27;s built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
260 &quot;imei&quot;: &quot;A String&quot;, # The device’s IMEI number. Validated on input.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800261 &quot;model&quot;: &quot;A String&quot;, # The device model&#x27;s name. Matches the device&#x27;s built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700262 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700263 },
264 }
265
266 x__xgafv: string, V1 error format.
267 Allowed values
268 1 - v1 error format
269 2 - v2 error format
270
271Returns:
272 An object of the form:
273
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700274 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700275 }</pre>
276</div>
277
278<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700279 <code class="details" id="unclaim">unclaim(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700280 <pre>Unclaims 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 device into zero-touch enrollment again.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700281
282Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700283 parent: string, Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700284 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700285 The object takes the form of:
286
287{ # Request message for customer to unclaim a device.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700288 &quot;device&quot;: { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it&#x27;s more flexible for the caller. To learn more about device identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device to unclaim.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800289 &quot;deviceId&quot;: &quot;A String&quot;, # The ID of the device.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700290 &quot;deviceIdentifier&quot;: { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs of the device.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800291 &quot;serialNumber&quot;: &quot;A String&quot;, # The manufacturer&#x27;s serial number for the device. This value might not be unique across different device models.
292 &quot;meid&quot;: &quot;A String&quot;, # The device’s MEID number.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800293 &quot;manufacturer&quot;: &quot;A String&quot;, # The device manufacturer’s name. Matches the device&#x27;s built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
294 &quot;imei&quot;: &quot;A String&quot;, # The device’s IMEI number. Validated on input.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800295 &quot;model&quot;: &quot;A String&quot;, # The device model&#x27;s name. Matches the device&#x27;s built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700296 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700297 },
298 }
299
300 x__xgafv: string, V1 error format.
301 Allowed values
302 1 - v1 error format
303 2 - v2 error format
304
305Returns:
306 An object of the form:
307
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700308 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700309 }</pre>
310</div>
311
312</body></html>