Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / androiddeviceprovisioning_v1.customers.devices.html
blob: af81f6dbd25f549925554328c1725a86c51e1f9f [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<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 -0700[diff] [blame]78 <code><a href="#applyConfiguration">applyConfiguration(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Applies a Configuration to the device to register the device for zero-touch</p>
80<p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets the details of a device.</p>
83<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Lists a customer's devices.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#removeConfiguration">removeConfiguration(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Removes a configuration from device.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#unclaim">unclaim(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Unclaims a device from a customer and removes it from zero-touch</p>
95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 <code class="details" id="applyConfiguration">applyConfiguration(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 <pre>Applies a Configuration to the device to register the device for zero-touch
99enrollment. After applying a configuration to a device, the device
100automatically provisions itself on first boot, or next factory reset.
101
102Args:
103 parent: string, Required. The customer managing the device. An API resource name in the
104format `customers/[CUSTOMER_ID]`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]105 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 The object takes the form of:
107
108{ # Request message for customer to assign a configuration to device.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 &quot;device&quot;: { # A `DeviceReference` is an API abstraction that lets you supply a _device_ # Required. The device the configuration is applied to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 # argument to a method using one of the following identifier types:
111 #
112 # * A numeric API resource ID.
113 # * Real-world hardware IDs, such as IMEI number, belonging to the manufactured
114 # device.
115 #
116 # Methods that operate on devices take a `DeviceReference` as a parameter type
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 # because it&#x27;s more flexible for the caller. To learn more about device
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 # identifiers, read [Identifiers](/zero-touch/guides/identifiers).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 &quot;deviceId&quot;: &quot;A String&quot;, # The ID of the device.
120 &quot;deviceIdentifier&quot;: { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs of the device.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 # To understand requirements on identifier sets, read
122 # [Identifiers](/zero-touch/guides/identifiers).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &quot;manufacturer&quot;: &quot;A String&quot;, # The device manufacturer’s name. Matches the device&#x27;s built-in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 # value returned from `android.os.Build.MANUFACTURER`. Allowed values are
125 # listed in
126 # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]127 &quot;meid&quot;: &quot;A String&quot;, # The device’s MEID number.
128 &quot;imei&quot;: &quot;A String&quot;, # The device’s IMEI number. Validated on input.
129 &quot;serialNumber&quot;: &quot;A String&quot;, # The manufacturer&#x27;s serial number for the device. This value might not be
130 # unique across different device models.
131 &quot;model&quot;: &quot;A String&quot;, # The device model&#x27;s name. Matches the device&#x27;s built-in value returned from
132 # `android.os.Build.MODEL`. Allowed values are listed in
133 # [models](/zero-touch/resources/manufacturer-names#model-names).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]134 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]136 &quot;configuration&quot;: &quot;A String&quot;, # Required. The configuration applied to the device in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
138 }
139
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145Returns:
146 An object of the form:
147
148 { # A generic empty message that you can re-use to avoid defining duplicated
149 # empty messages in your APIs. A typical example is to use it as the request
150 # or the response type of an API method. For instance:
151 #
152 # service Foo {
153 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
154 # }
155 #
156 # The JSON representation for `Empty` is empty JSON object `{}`.
157 }</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="get">get(name, x__xgafv=None)</code>
162 <pre>Gets the details of a device.
163
164Args:
165 name: string, Required. The device to get. An API resource name in the format
166`customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`. (required)
167 x__xgafv: string, V1 error format.
168 Allowed values
169 1 - v1 error format
170 2 - v2 error format
171
172Returns:
173 An object of the form:
174
175 { # An Android device registered for zero-touch enrollment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 &quot;deviceIdentifier&quot;: { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 # [Identifiers](/zero-touch/guides/identifiers).
178 # To understand requirements on identifier sets, read
179 # [Identifiers](/zero-touch/guides/identifiers).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]180 &quot;manufacturer&quot;: &quot;A String&quot;, # The device manufacturer’s name. Matches the device&#x27;s built-in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 # value returned from `android.os.Build.MANUFACTURER`. Allowed values are
182 # listed in
183 # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 &quot;meid&quot;: &quot;A String&quot;, # The device’s MEID number.
185 &quot;imei&quot;: &quot;A String&quot;, # The device’s IMEI number. Validated on input.
186 &quot;serialNumber&quot;: &quot;A String&quot;, # The manufacturer&#x27;s serial number for the device. This value might not be
187 # unique across different device models.
188 &quot;model&quot;: &quot;A String&quot;, # The device model&#x27;s name. Matches the device&#x27;s built-in value returned from
189 # `android.os.Build.MODEL`. Allowed values are listed in
190 # [models](/zero-touch/resources/manufacturer-names#model-names).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]192 &quot;deviceId&quot;: &quot;A String&quot;, # Output only. The ID of the device. Assigned by the server.
193 &quot;deviceMetadata&quot;: { # Metadata entries that can be attached to a `Device`. To learn more, read # The metadata attached to the device. Structured as key-value pairs. To
194 # learn more, read [Device metadata](/zero-touch/guides/metadata).
195 # [Device metadata](/zero-touch/guides/metadata).
196 &quot;entries&quot;: { # Metadata entries recorded as key-value pairs.
197 &quot;a_key&quot;: &quot;A String&quot;,
198 },
199 },
200 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]202 &quot;claims&quot;: [ # Output only. The provisioning claims for a device. Devices claimed for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]203 # zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.
204 # Call
205 # `partners.devices.unclaim`
206 # or
207 # `partners.devices.unclaimAsync`
208 # to remove the device from zero-touch enrollment.
209 { # A record of a device claimed by a reseller for a customer. Devices claimed
210 # for zero-touch enrollment have a claim with the type
211 # `SECTION_TYPE_ZERO_TOUCH`. To learn more, read
212 # [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]213 &quot;resellerId&quot;: &quot;A String&quot;, # The ID of the reseller that claimed the device.
214 &quot;sectionType&quot;: &quot;A String&quot;, # Output only. The type of claim made on the device.
215 &quot;vacationModeStartTime&quot;: &quot;A String&quot;, # The timestamp when the device was put into ‘vacation mode’. This value is
216 # present iff the device is in &#x27;vacation mode&#x27;.
217 &quot;vacationModeExpireTime&quot;: &quot;A String&quot;, # The timestamp when the device will exit ‘vacation mode’. This value is
218 # present iff the device is in &#x27;vacation mode&#x27;.
219 &quot;ownerCompanyId&quot;: &quot;A String&quot;, # The ID of the Customer that purchased the device.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220 },
221 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]222 &quot;configuration&quot;: &quot;A String&quot;, # Not available to resellers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 }</pre>
224</div>
225
226<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]227 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
228 <pre>Lists a customer&#x27;s devices.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229
230Args:
231 parent: string, Required. The customer managing the devices. An API resource name in the
232format `customers/[CUSTOMER_ID]`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]233 pageSize: string, The maximum number of devices to show in a page of results.
234Must be between 1 and 100 inclusive.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235 pageToken: string, A token specifying which result page to return.
236 x__xgafv: string, V1 error format.
237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240
241Returns:
242 An object of the form:
243
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]244 { # Response message of customer&#x27;s liting devices.
245 &quot;devices&quot;: [ # The customer&#x27;s devices.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 { # An Android device registered for zero-touch enrollment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]247 &quot;deviceIdentifier&quot;: { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 # [Identifiers](/zero-touch/guides/identifiers).
249 # To understand requirements on identifier sets, read
250 # [Identifiers](/zero-touch/guides/identifiers).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]251 &quot;manufacturer&quot;: &quot;A String&quot;, # The device manufacturer’s name. Matches the device&#x27;s built-in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252 # value returned from `android.os.Build.MANUFACTURER`. Allowed values are
253 # listed in
254 # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]255 &quot;meid&quot;: &quot;A String&quot;, # The device’s MEID number.
256 &quot;imei&quot;: &quot;A String&quot;, # The device’s IMEI number. Validated on input.
257 &quot;serialNumber&quot;: &quot;A String&quot;, # The manufacturer&#x27;s serial number for the device. This value might not be
258 # unique across different device models.
259 &quot;model&quot;: &quot;A String&quot;, # The device model&#x27;s name. Matches the device&#x27;s built-in value returned from
260 # `android.os.Build.MODEL`. Allowed values are listed in
261 # [models](/zero-touch/resources/manufacturer-names#model-names).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]263 &quot;deviceId&quot;: &quot;A String&quot;, # Output only. The ID of the device. Assigned by the server.
264 &quot;deviceMetadata&quot;: { # Metadata entries that can be attached to a `Device`. To learn more, read # The metadata attached to the device. Structured as key-value pairs. To
265 # learn more, read [Device metadata](/zero-touch/guides/metadata).
266 # [Device metadata](/zero-touch/guides/metadata).
267 &quot;entries&quot;: { # Metadata entries recorded as key-value pairs.
268 &quot;a_key&quot;: &quot;A String&quot;,
269 },
270 },
271 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]272 # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]273 &quot;claims&quot;: [ # Output only. The provisioning claims for a device. Devices claimed for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]274 # zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.
275 # Call
276 # `partners.devices.unclaim`
277 # or
278 # `partners.devices.unclaimAsync`
279 # to remove the device from zero-touch enrollment.
280 { # A record of a device claimed by a reseller for a customer. Devices claimed
281 # for zero-touch enrollment have a claim with the type
282 # `SECTION_TYPE_ZERO_TOUCH`. To learn more, read
283 # [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]284 &quot;resellerId&quot;: &quot;A String&quot;, # The ID of the reseller that claimed the device.
285 &quot;sectionType&quot;: &quot;A String&quot;, # Output only. The type of claim made on the device.
286 &quot;vacationModeStartTime&quot;: &quot;A String&quot;, # The timestamp when the device was put into ‘vacation mode’. This value is
287 # present iff the device is in &#x27;vacation mode&#x27;.
288 &quot;vacationModeExpireTime&quot;: &quot;A String&quot;, # The timestamp when the device will exit ‘vacation mode’. This value is
289 # present iff the device is in &#x27;vacation mode&#x27;.
290 &quot;ownerCompanyId&quot;: &quot;A String&quot;, # The ID of the Customer that purchased the device.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291 },
292 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]293 &quot;configuration&quot;: &quot;A String&quot;, # Not available to resellers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]294 },
295 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]296 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token used to access the next page of results. Omitted if no further
297 # results are available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]298 }</pre>
299</div>
300
301<div class="method">
302 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
303 <pre>Retrieves the next page of results.
304
305Args:
306 previous_request: The request for the previous page. (required)
307 previous_response: The response from the request for the previous page. (required)
308
309Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]310 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]311 page. Returns None if there are no more items in the collection.
312 </pre>
313</div>
314
315<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]316 <code class="details" id="removeConfiguration">removeConfiguration(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]317 <pre>Removes a configuration from device.
318
319Args:
320 parent: string, Required. The customer managing the device in the format
321`customers/[CUSTOMER_ID]`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]322 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]323 The object takes the form of:
324
325{ # Request message for customer to remove the configuration from device.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]326 &quot;device&quot;: { # A `DeviceReference` is an API abstraction that lets you supply a _device_ # Required. The device to remove the configuration from.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]327 # argument to a method using one of the following identifier types:
328 #
329 # * A numeric API resource ID.
330 # * Real-world hardware IDs, such as IMEI number, belonging to the manufactured
331 # device.
332 #
333 # Methods that operate on devices take a `DeviceReference` as a parameter type
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]334 # because it&#x27;s more flexible for the caller. To learn more about device
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]335 # identifiers, read [Identifiers](/zero-touch/guides/identifiers).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]336 &quot;deviceId&quot;: &quot;A String&quot;, # The ID of the device.
337 &quot;deviceIdentifier&quot;: { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs of the device.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]338 # To understand requirements on identifier sets, read
339 # [Identifiers](/zero-touch/guides/identifiers).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]340 &quot;manufacturer&quot;: &quot;A String&quot;, # The device manufacturer’s name. Matches the device&#x27;s built-in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]341 # value returned from `android.os.Build.MANUFACTURER`. Allowed values are
342 # listed in
343 # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]344 &quot;meid&quot;: &quot;A String&quot;, # The device’s MEID number.
345 &quot;imei&quot;: &quot;A String&quot;, # The device’s IMEI number. Validated on input.
346 &quot;serialNumber&quot;: &quot;A String&quot;, # The manufacturer&#x27;s serial number for the device. This value might not be
347 # unique across different device models.
348 &quot;model&quot;: &quot;A String&quot;, # The device model&#x27;s name. Matches the device&#x27;s built-in value returned from
349 # `android.os.Build.MODEL`. Allowed values are listed in
350 # [models](/zero-touch/resources/manufacturer-names#model-names).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]351 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]352 },
353 }
354
355 x__xgafv: string, V1 error format.
356 Allowed values
357 1 - v1 error format
358 2 - v2 error format
359
360Returns:
361 An object of the form:
362
363 { # A generic empty message that you can re-use to avoid defining duplicated
364 # empty messages in your APIs. A typical example is to use it as the request
365 # or the response type of an API method. For instance:
366 #
367 # service Foo {
368 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
369 # }
370 #
371 # The JSON representation for `Empty` is empty JSON object `{}`.
372 }</pre>
373</div>
374
375<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]376 <code class="details" id="unclaim">unclaim(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]377 <pre>Unclaims a device from a customer and removes it from zero-touch
378enrollment.
379
380After removing a device, a customer must contact their reseller to register
381the device into zero-touch enrollment again.
382
383Args:
384 parent: string, Required. The customer managing the device. An API resource name in the
385format `customers/[CUSTOMER_ID]`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]386 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]387 The object takes the form of:
388
389{ # Request message for customer to unclaim a device.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]390 &quot;device&quot;: { # A `DeviceReference` is an API abstraction that lets you supply a _device_ # Required. The device to unclaim.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]391 # argument to a method using one of the following identifier types:
392 #
393 # * A numeric API resource ID.
394 # * Real-world hardware IDs, such as IMEI number, belonging to the manufactured
395 # device.
396 #
397 # Methods that operate on devices take a `DeviceReference` as a parameter type
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]398 # because it&#x27;s more flexible for the caller. To learn more about device
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399 # identifiers, read [Identifiers](/zero-touch/guides/identifiers).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]400 &quot;deviceId&quot;: &quot;A String&quot;, # The ID of the device.
401 &quot;deviceIdentifier&quot;: { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs of the device.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]402 # To understand requirements on identifier sets, read
403 # [Identifiers](/zero-touch/guides/identifiers).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]404 &quot;manufacturer&quot;: &quot;A String&quot;, # The device manufacturer’s name. Matches the device&#x27;s built-in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]405 # value returned from `android.os.Build.MANUFACTURER`. Allowed values are
406 # listed in
407 # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]408 &quot;meid&quot;: &quot;A String&quot;, # The device’s MEID number.
409 &quot;imei&quot;: &quot;A String&quot;, # The device’s IMEI number. Validated on input.
410 &quot;serialNumber&quot;: &quot;A String&quot;, # The manufacturer&#x27;s serial number for the device. This value might not be
411 # unique across different device models.
412 &quot;model&quot;: &quot;A String&quot;, # The device model&#x27;s name. Matches the device&#x27;s built-in value returned from
413 # `android.os.Build.MODEL`. Allowed values are listed in
414 # [models](/zero-touch/resources/manufacturer-names#model-names).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]415 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]416 },
417 }
418
419 x__xgafv: string, V1 error format.
420 Allowed values
421 1 - v1 error format
422 2 - v2 error format
423
424Returns:
425 An object of the form:
426
427 { # A generic empty message that you can re-use to avoid defining duplicated
428 # empty messages in your APIs. A typical example is to use it as the request
429 # or the response type of an API method. For instance:
430 #
431 # service Foo {
432 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
433 # }
434 #
435 # The JSON representation for `Empty` is empty JSON object `{}`.
436 }</pre>
437</div>
438
439</body></html>