/
cloudidentity_v1beta1.devices.html
536 lines (486 loc) 路 42.2 KB
/
cloudidentity_v1beta1.devices.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="cloudidentity_v1beta1.html">Cloud Identity API</a> . <a href="cloudidentity_v1beta1.devices.html">devices</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="cloudidentity_v1beta1.devices.deviceUsers.html">deviceUsers()</a></code>
</p>
<p class="firstline">Returns the deviceUsers Resource.</p>
<p class="toc_element">
<code><a href="#cancelWipe">cancelWipe(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a device. Only company-owned device may be created. **Note**: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium</p>
<p class="toc_element">
<code><a href="#delete">delete(name, customer=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified device.</p>
<p class="toc_element">
<code><a href="#get">get(name, customer=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified device.</p>
<p class="toc_element">
<code><a href="#list">list(customer=None, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists/Searches devices.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#wipe">wipe(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Wipes all data on the specified device.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="cancelWipe">cancelWipe(name, body=None, x__xgafv=None)</code>
<pre>Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped.
Args:
name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the Device. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for cancelling an unfinished device wipe.
"customer": "A String", # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(body=None, x__xgafv=None)</code>
<pre>Creates a device. Only company-owned device may be created. **Note**: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium
Args:
body: object, The request body.
The object takes the form of:
{ # Request message for creating a Company Owned device.
"customer": "A String", # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
"device": { # A Device within the Cloud Identity Devices API. Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user. # Required. The device to be created. The name field within this device is ignored in the create method. A new name is created by the method, and returned within the response. Only the fields `device_type`, `serial_number` and `asset_tag` (if present) are used to create the device. All other fields are ignored. The `device_type` and `serial_number` fields are required.
"androidSpecificAttributes": { # Resource representing the Android specific attributes of a Device. # Output only. Attributes specific to Android devices.
"ctsProfileMatch": True or False, # Whether the device passes Android CTS compliance.
"enabledUnknownSources": True or False, # Whether applications from unknown sources can be installed on device.
"hasPotentiallyHarmfulApps": True or False, # Whether any potentially harmful apps were detected on the device.
"ownerProfileAccount": True or False, # Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.
"ownershipPrivilege": "A String", # Ownership privileges on device.
"supportsWorkProfile": True or False, # Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.
"verifiedBoot": True or False, # Whether Android verified boot status is GREEN.
"verifyAppsEnabled": True or False, # Whether Google Play Protect Verify Apps is enabled.
},
"assetTag": "A String", # Asset tag of the device.
"basebandVersion": "A String", # Output only. Baseband version of the device.
"bootloaderVersion": "A String", # Output only. Device bootloader version. Example: 0.6.7.
"brand": "A String", # Output only. Device brand. Example: Samsung.
"buildNumber": "A String", # Output only. Build number of the device.
"clientTypes": [ # List of the clients the device is reporting to.
"A String",
],
"compromisedState": "A String", # Output only. Represents whether the Device is compromised.
"createTime": "A String", # Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.
"deviceId": "A String", # Unique identifier for the device.
"deviceType": "A String", # Output only. Type of device.
"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device.
"enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device.
"encryptionState": "A String", # Output only. Device encryption state.
"endpointVerificationSpecificAttributes": { # Resource representing the Endpoint Verification-specific attributes of a Device. https://cloud.google.com/endpoint-verification/docs/overview # Output only. Attributes specific to Endpoint Verification devices.
"certificateAttributes": [ # Details of certificates.
{ # Stores information about a certificate.
"certificateTemplate": { # CertificateTemplate (v3 Extension in X.509). # The X.509 extension for CertificateTemplate.
"id": "A String", # The template id of the template. Example: "1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7784047".
"majorVersion": 42, # The Major version of the template. Example: 100.
"minorVersion": 42, # The minor version of the template. Example: 12.
},
"fingerprint": "A String", # The encoded certificate fingerprint.
"issuer": "A String", # The name of the issuer of this certificate.
"serialNumber": "A String", # Serial number of the certificate, Example: "123456789".
"subject": "A String", # The subject name of this certificate.
"thumbprint": "A String", # The certificate thumbprint.
"validationState": "A String", # Validation state of this certificate.
"validityExpirationTime": "A String", # Certificate not valid at or after this timestamp.
"validityStartTime": "A String", # Certificate not valid before this timestamp.
},
],
},
"hostname": "A String", # Host name of the device.
"imei": "A String", # Output only. IMEI number of device if GSM device; empty otherwise.
"kernelVersion": "A String", # Output only. Kernel version of the device.
"lastSyncTime": "A String", # Most recent time when device synced with this service.
"managementState": "A String", # Output only. Management state of the device
"manufacturer": "A String", # Output only. Device manufacturer. Example: Motorola.
"meid": "A String", # Output only. MEID number of device if CDMA device; empty otherwise.
"model": "A String", # Output only. Model name of device. Example: Pixel 3.
"name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique id assigned to the Device.
"networkOperator": "A String", # Output only. Mobile or network operator of device, if available.
"osVersion": "A String", # Output only. OS version of the device. Example: Android 8.1.0.
"otherAccounts": [ # Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".
"A String",
],
"ownerType": "A String", # Output only. Whether the device is owned by the company or an individual
"releaseVersion": "A String", # Output only. OS release version. Example: 6.0.
"securityPatchTime": "A String", # Output only. OS security patch update time on device.
"serialNumber": "A String", # Serial Number of device. Example: HT82V1A01076.
"wifiMacAddresses": [ # WiFi MAC addresses of device.
"A String",
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, customer=None, x__xgafv=None)</code>
<pre>Deletes the specified device.
Args:
name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the Device. (required)
customer: string, Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, customer=None, x__xgafv=None)</code>
<pre>Retrieves the specified device.
Args:
name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the Device. (required)
customer: string, Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Customer in format: `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Device within the Cloud Identity Devices API. Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user.
"androidSpecificAttributes": { # Resource representing the Android specific attributes of a Device. # Output only. Attributes specific to Android devices.
"ctsProfileMatch": True or False, # Whether the device passes Android CTS compliance.
"enabledUnknownSources": True or False, # Whether applications from unknown sources can be installed on device.
"hasPotentiallyHarmfulApps": True or False, # Whether any potentially harmful apps were detected on the device.
"ownerProfileAccount": True or False, # Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.
"ownershipPrivilege": "A String", # Ownership privileges on device.
"supportsWorkProfile": True or False, # Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.
"verifiedBoot": True or False, # Whether Android verified boot status is GREEN.
"verifyAppsEnabled": True or False, # Whether Google Play Protect Verify Apps is enabled.
},
"assetTag": "A String", # Asset tag of the device.
"basebandVersion": "A String", # Output only. Baseband version of the device.
"bootloaderVersion": "A String", # Output only. Device bootloader version. Example: 0.6.7.
"brand": "A String", # Output only. Device brand. Example: Samsung.
"buildNumber": "A String", # Output only. Build number of the device.
"clientTypes": [ # List of the clients the device is reporting to.
"A String",
],
"compromisedState": "A String", # Output only. Represents whether the Device is compromised.
"createTime": "A String", # Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.
"deviceId": "A String", # Unique identifier for the device.
"deviceType": "A String", # Output only. Type of device.
"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device.
"enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device.
"encryptionState": "A String", # Output only. Device encryption state.
"endpointVerificationSpecificAttributes": { # Resource representing the Endpoint Verification-specific attributes of a Device. https://cloud.google.com/endpoint-verification/docs/overview # Output only. Attributes specific to Endpoint Verification devices.
"certificateAttributes": [ # Details of certificates.
{ # Stores information about a certificate.
"certificateTemplate": { # CertificateTemplate (v3 Extension in X.509). # The X.509 extension for CertificateTemplate.
"id": "A String", # The template id of the template. Example: "1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7784047".
"majorVersion": 42, # The Major version of the template. Example: 100.
"minorVersion": 42, # The minor version of the template. Example: 12.
},
"fingerprint": "A String", # The encoded certificate fingerprint.
"issuer": "A String", # The name of the issuer of this certificate.
"serialNumber": "A String", # Serial number of the certificate, Example: "123456789".
"subject": "A String", # The subject name of this certificate.
"thumbprint": "A String", # The certificate thumbprint.
"validationState": "A String", # Validation state of this certificate.
"validityExpirationTime": "A String", # Certificate not valid at or after this timestamp.
"validityStartTime": "A String", # Certificate not valid before this timestamp.
},
],
},
"hostname": "A String", # Host name of the device.
"imei": "A String", # Output only. IMEI number of device if GSM device; empty otherwise.
"kernelVersion": "A String", # Output only. Kernel version of the device.
"lastSyncTime": "A String", # Most recent time when device synced with this service.
"managementState": "A String", # Output only. Management state of the device
"manufacturer": "A String", # Output only. Device manufacturer. Example: Motorola.
"meid": "A String", # Output only. MEID number of device if CDMA device; empty otherwise.
"model": "A String", # Output only. Model name of device. Example: Pixel 3.
"name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique id assigned to the Device.
"networkOperator": "A String", # Output only. Mobile or network operator of device, if available.
"osVersion": "A String", # Output only. OS version of the device. Example: Android 8.1.0.
"otherAccounts": [ # Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".
"A String",
],
"ownerType": "A String", # Output only. Whether the device is owned by the company or an individual
"releaseVersion": "A String", # Output only. OS release version. Example: 6.0.
"securityPatchTime": "A String", # Output only. OS security patch update time on device.
"serialNumber": "A String", # Serial Number of device. Example: HT82V1A01076.
"wifiMacAddresses": [ # WiFi MAC addresses of device.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customer=None, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>Lists/Searches devices.
Args:
customer: string, Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer.
filter: string, Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to [Mobile device search fields](https://developers.google.com/admin-sdk/directory/v1/search-operators). Multiple search fields are separated by the space character.
orderBy: string, Optional. Order specification for devices in the response. Only one of the following field names may be used to specify the order: `create_time`, `last_sync_time`, `model`, `os_version`, `device_type` and `serial_number`. `desc` may be specified optionally to specify results to be sorted in descending order. Default order is ascending.
pageSize: integer, Optional. The maximum number of Devices to return. If unspecified, at most 20 Devices will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken: string, Optional. A page token, received from a previous `ListDevices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDevices` must match the call that provided the page token.
view: string, Optional. The view to use for the List request.
Allowed values
VIEW_UNSPECIFIED - Default value. The value is unused.
COMPANY_INVENTORY - This view contains all devices imported by the company admin. Each device in the response contains all information specified by the company admin when importing the device (i.e. asset tags).
USER_ASSIGNED_DEVICES - This view contains all devices with at least one user registered on the device. Each device in the response contains all device information, except for asset tags.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message that is returned from the ListDevices method.
"devices": [ # Devices meeting the list restrictions.
{ # A Device within the Cloud Identity Devices API. Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user.
"androidSpecificAttributes": { # Resource representing the Android specific attributes of a Device. # Output only. Attributes specific to Android devices.
"ctsProfileMatch": True or False, # Whether the device passes Android CTS compliance.
"enabledUnknownSources": True or False, # Whether applications from unknown sources can be installed on device.
"hasPotentiallyHarmfulApps": True or False, # Whether any potentially harmful apps were detected on the device.
"ownerProfileAccount": True or False, # Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.
"ownershipPrivilege": "A String", # Ownership privileges on device.
"supportsWorkProfile": True or False, # Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.
"verifiedBoot": True or False, # Whether Android verified boot status is GREEN.
"verifyAppsEnabled": True or False, # Whether Google Play Protect Verify Apps is enabled.
},
"assetTag": "A String", # Asset tag of the device.
"basebandVersion": "A String", # Output only. Baseband version of the device.
"bootloaderVersion": "A String", # Output only. Device bootloader version. Example: 0.6.7.
"brand": "A String", # Output only. Device brand. Example: Samsung.
"buildNumber": "A String", # Output only. Build number of the device.
"clientTypes": [ # List of the clients the device is reporting to.
"A String",
],
"compromisedState": "A String", # Output only. Represents whether the Device is compromised.
"createTime": "A String", # Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.
"deviceId": "A String", # Unique identifier for the device.
"deviceType": "A String", # Output only. Type of device.
"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device.
"enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device.
"encryptionState": "A String", # Output only. Device encryption state.
"endpointVerificationSpecificAttributes": { # Resource representing the Endpoint Verification-specific attributes of a Device. https://cloud.google.com/endpoint-verification/docs/overview # Output only. Attributes specific to Endpoint Verification devices.
"certificateAttributes": [ # Details of certificates.
{ # Stores information about a certificate.
"certificateTemplate": { # CertificateTemplate (v3 Extension in X.509). # The X.509 extension for CertificateTemplate.
"id": "A String", # The template id of the template. Example: "1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7784047".
"majorVersion": 42, # The Major version of the template. Example: 100.
"minorVersion": 42, # The minor version of the template. Example: 12.
},
"fingerprint": "A String", # The encoded certificate fingerprint.
"issuer": "A String", # The name of the issuer of this certificate.
"serialNumber": "A String", # Serial number of the certificate, Example: "123456789".
"subject": "A String", # The subject name of this certificate.
"thumbprint": "A String", # The certificate thumbprint.
"validationState": "A String", # Validation state of this certificate.
"validityExpirationTime": "A String", # Certificate not valid at or after this timestamp.
"validityStartTime": "A String", # Certificate not valid before this timestamp.
},
],
},
"hostname": "A String", # Host name of the device.
"imei": "A String", # Output only. IMEI number of device if GSM device; empty otherwise.
"kernelVersion": "A String", # Output only. Kernel version of the device.
"lastSyncTime": "A String", # Most recent time when device synced with this service.
"managementState": "A String", # Output only. Management state of the device
"manufacturer": "A String", # Output only. Device manufacturer. Example: Motorola.
"meid": "A String", # Output only. MEID number of device if CDMA device; empty otherwise.
"model": "A String", # Output only. Model name of device. Example: Pixel 3.
"name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique id assigned to the Device.
"networkOperator": "A String", # Output only. Mobile or network operator of device, if available.
"osVersion": "A String", # Output only. OS version of the device. Example: Android 8.1.0.
"otherAccounts": [ # Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".
"A String",
],
"ownerType": "A String", # Output only. Whether the device is owned by the company or an individual
"releaseVersion": "A String", # Output only. OS release version. Example: 6.0.
"securityPatchTime": "A String", # Output only. OS security patch update time on device.
"serialNumber": "A String", # Serial Number of device. Example: HT82V1A01076.
"wifiMacAddresses": [ # WiFi MAC addresses of device.
"A String",
],
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results. Empty if there are no more results.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="wipe">wipe(name, body=None, x__xgafv=None)</code>
<pre>Wipes all data on the specified device.
Args:
name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for wiping all data on the device.
"customer": "A String", # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
"removeResetLock": True or False, # Optional. Specifies if a user is able to factory reset a device after a Device Wipe. On iOS, this is called "Activation Lock", while on Android, this is known as "Factory Reset Protection". If true, this protection will be removed from the device, so that a user can successfully factory reset. If false, the setting is untouched on the device.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>