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