/
admin_directory_v1.chromeosdevices.html
1032 lines (985 loc) 路 77.4 KB
/
admin_directory_v1.chromeosdevices.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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<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="admin_directory_v1.html">Admin SDK API</a> . <a href="admin_directory_v1.chromeosdevices.html">chromeosdevices</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#action">action(customerId, resourceId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633).</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="#get">get(customerId, deviceId, projection=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a Chrome OS device's properties.</p>
<p class="toc_element">
<code><a href="#list">list(customerId, includeChildOrgunits=None, maxResults=None, orderBy=None, orgUnitPath=None, pageToken=None, projection=None, query=None, sortOrder=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a paginated list of Chrome OS devices within an account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#moveDevicesToOu">moveDevicesToOu(customerId, orgUnitPath, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.</p>
<p class="toc_element">
<code><a href="#patch">patch(customerId, deviceId, body=None, projection=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).</p>
<p class="toc_element">
<code><a href="#update">update(customerId, deviceId, body=None, projection=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="action">action(customerId, resourceId, body=None, x__xgafv=None)</code>
<pre>Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633).
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
resourceId: string, The unique ID of the device. The `resourceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method. (required)
body: object, The request body.
The object takes the form of:
{
"action": "A String", # Action to be taken on the Chrome OS device.
"deprovisionReason": "A String", # Only used when the action is `deprovision`. With the `deprovision` action, this field is required. *Note*: The deprovision reason is audited because it might have implications on licenses for perpetual subscription customers.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</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="get">get(customerId, deviceId, projection=None, x__xgafv=None)</code>
<pre>Retrieves a Chrome OS device's properties.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
deviceId: string, The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method. (required)
projection: string, Determines whether the response contains the full list of properties or only a subset.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
FULL - Includes all metadata fields
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).
"activeTimeRanges": [ # List of active time ranges (Read-only).
{
"activeTime": 42, # Duration of usage in milliseconds.
"date": "A String", # Date of usage
},
],
"annotatedAssetId": "A String", # The asset identifier as noted by an administrator or specified during enrollment.
"annotatedLocation": "A String", # The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.
"annotatedUser": "A String", # The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
"autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support
"bootMode": "A String", # The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).
"cpuInfo": [ # Information regarding CPU specs in the device.
{ # CPU specs for a CPU.
"architecture": "A String", # The CPU architecture.
"logicalCpus": [ # Information for the Logical CPUs
{ # Status of a single logical CPU.
"cStates": [ # C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.
{ # Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.
"displayName": "A String", # Name of the state.
"sessionDuration": "A String", # Time spent in the state since the last reboot.
},
],
"currentScalingFrequencyKhz": 42, # Current frequency the CPU is running at.
"idleDuration": "A String", # Idle time since last boot.
"maxScalingFrequencyKhz": 42, # Maximum frequency the CPU is allowed to run at, by policy.
},
],
"maxClockSpeedKhz": 42, # The max CPU clock speed in kHz.
"model": "A String", # The CPU model name.
},
],
"cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only)
{
"cpuTemperatureInfo": [ # List of CPU temperature samples.
{
"label": "A String", # CPU label
"temperature": 42, # Temperature in Celsius degrees.
},
],
"cpuUtilizationPercentageInfo": [
42,
],
"reportTime": "A String", # Date and time the report was received.
},
],
"deviceFiles": [ # List of device files to download (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"deviceId": "A String", # The unique ID of the Chrome device.
"diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes.
{
"volumeInfo": [ # Disk volumes
{
"storageFree": "A String", # Free disk space [in bytes]
"storageTotal": "A String", # Total disk space [in bytes]
"volumeId": "A String", # Volume id
},
],
},
],
"dockMacAddress": "A String", # (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.
"etag": "A String", # ETag of the resource.
"ethernetMacAddress": "A String", # The device's MAC address on the ethernet network interface.
"ethernetMacAddress0": "A String", # (Read-only) MAC address used by the Chromebook鈥檚 internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.
"firmwareVersion": "A String", # The Chrome device's firmware version.
"kind": "admin#directory#chromeosdevice", # The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"lastKnownNetwork": [ # Contains last known network (Read-only)
{ # Information for an ip address.
"ipAddress": "A String", # The IP address.
"wanIpAddress": "A String", # The WAN IP address.
},
],
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response.
"manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format.
"meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).
"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response.
"notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.
"orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number.
"orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"osVersion": "A String", # The Chrome device's operating system version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # List of recent device users, in descending order, by last login time.
{ # List of recent device users, in descending order, by last login time.
"email": "A String", # The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
"type": "A String", # The type of the user.
},
],
"screenshotFiles": [ # List of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"serialNumber": "A String", # The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's *Serial Number* in the *Chrome OS Devices* tab.
"status": "A String", # The status of the device.
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only)
{
"reportTime": "A String", # Date and time the report was received.
"systemRamFreeInfo": [
"A String",
],
},
],
"systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only)
"tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only)
"family": "A String", # TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: "1.2" -> 312e3200 TPM 2.0: "2.0" -> 322e3000
"firmwareVersion": "A String", # TPM firmware version.
"manufacturer": "A String", # TPM manufacturer code.
"specLevel": "A String", # TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.
"tpmModel": "A String", # TPM model number.
"vendorSpecific": "A String", # Vendor-specific information such as Vendor ID.
},
"willAutoRenew": True or False, # Determines if the device will auto renew its support after the support end date. This is a read-only property.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customerId, includeChildOrgunits=None, maxResults=None, orderBy=None, orgUnitPath=None, pageToken=None, projection=None, query=None, sortOrder=None, x__xgafv=None)</code>
<pre>Retrieves a paginated list of Chrome OS devices within an account.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
includeChildOrgunits: boolean, Return devices from all child orgunits, as well as the specified org unit. If this is set to true 'orgUnitPath' must be provided.
maxResults: integer, Maximum number of results to return.
orderBy: string, Device property to use for sorting results.
Allowed values
annotatedLocation - Chrome device location as annotated by the administrator.
annotatedUser - Chromebook user as annotated by administrator.
lastSync - The date and time the Chrome device was last synchronized with the policy settings in the Admin console.
notes - Chrome device notes as annotated by the administrator.
serialNumber - The Chrome device serial number entered when the device was enabled.
status - Chrome device status. For more information, see the <a [chromeosdevices](/admin-sdk/directory/v1/reference/chromeosdevices.html).
supportEndDate - Chrome device support end date. This is applicable only for devices purchased directly from Google.
orgUnitPath: string, The full path of the organizational unit or its unique ID.
pageToken: string, The `pageToken` query parameter is used to request the next page of query results. The follow-on request's `pageToken` query parameter is the `nextPageToken` from your previous response.
projection: string, Restrict information returned to a set of selected fields.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
FULL - Includes all metadata fields
query: string, Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?answer=1698333
sortOrder: string, Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"chromeosdevices": [ # List of Chrome OS Device objects.
{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).
"activeTimeRanges": [ # List of active time ranges (Read-only).
{
"activeTime": 42, # Duration of usage in milliseconds.
"date": "A String", # Date of usage
},
],
"annotatedAssetId": "A String", # The asset identifier as noted by an administrator or specified during enrollment.
"annotatedLocation": "A String", # The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.
"annotatedUser": "A String", # The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
"autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support
"bootMode": "A String", # The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).
"cpuInfo": [ # Information regarding CPU specs in the device.
{ # CPU specs for a CPU.
"architecture": "A String", # The CPU architecture.
"logicalCpus": [ # Information for the Logical CPUs
{ # Status of a single logical CPU.
"cStates": [ # C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.
{ # Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.
"displayName": "A String", # Name of the state.
"sessionDuration": "A String", # Time spent in the state since the last reboot.
},
],
"currentScalingFrequencyKhz": 42, # Current frequency the CPU is running at.
"idleDuration": "A String", # Idle time since last boot.
"maxScalingFrequencyKhz": 42, # Maximum frequency the CPU is allowed to run at, by policy.
},
],
"maxClockSpeedKhz": 42, # The max CPU clock speed in kHz.
"model": "A String", # The CPU model name.
},
],
"cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only)
{
"cpuTemperatureInfo": [ # List of CPU temperature samples.
{
"label": "A String", # CPU label
"temperature": 42, # Temperature in Celsius degrees.
},
],
"cpuUtilizationPercentageInfo": [
42,
],
"reportTime": "A String", # Date and time the report was received.
},
],
"deviceFiles": [ # List of device files to download (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"deviceId": "A String", # The unique ID of the Chrome device.
"diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes.
{
"volumeInfo": [ # Disk volumes
{
"storageFree": "A String", # Free disk space [in bytes]
"storageTotal": "A String", # Total disk space [in bytes]
"volumeId": "A String", # Volume id
},
],
},
],
"dockMacAddress": "A String", # (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.
"etag": "A String", # ETag of the resource.
"ethernetMacAddress": "A String", # The device's MAC address on the ethernet network interface.
"ethernetMacAddress0": "A String", # (Read-only) MAC address used by the Chromebook鈥檚 internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.
"firmwareVersion": "A String", # The Chrome device's firmware version.
"kind": "admin#directory#chromeosdevice", # The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"lastKnownNetwork": [ # Contains last known network (Read-only)
{ # Information for an ip address.
"ipAddress": "A String", # The IP address.
"wanIpAddress": "A String", # The WAN IP address.
},
],
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response.
"manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format.
"meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).
"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response.
"notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.
"orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number.
"orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"osVersion": "A String", # The Chrome device's operating system version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # List of recent device users, in descending order, by last login time.
{ # List of recent device users, in descending order, by last login time.
"email": "A String", # The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
"type": "A String", # The type of the user.
},
],
"screenshotFiles": [ # List of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"serialNumber": "A String", # The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's *Serial Number* in the *Chrome OS Devices* tab.
"status": "A String", # The status of the device.
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only)
{
"reportTime": "A String", # Date and time the report was received.
"systemRamFreeInfo": [
"A String",
],
},
],
"systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only)
"tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only)
"family": "A String", # TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: "1.2" -> 312e3200 TPM 2.0: "2.0" -> 322e3000
"firmwareVersion": "A String", # TPM firmware version.
"manufacturer": "A String", # TPM manufacturer code.
"specLevel": "A String", # TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.
"tpmModel": "A String", # TPM model number.
"vendorSpecific": "A String", # Vendor-specific information such as Vendor ID.
},
"willAutoRenew": True or False, # Determines if the device will auto renew its support after the support end date. This is a read-only property.
},
],
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#chromeosdevices", # Kind of resource this is.
"nextPageToken": "A String", # Token used to access the next page of this result. To access the next page, use this token's value in the `pageToken` query string of this request.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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="moveDevicesToOu">moveDevicesToOu(customerId, orgUnitPath, body=None, x__xgafv=None)</code>
<pre>Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.
Args:
customerId: string, Immutable ID of the Google Workspace account (required)
orgUnitPath: string, Full path of the target organizational unit or its ID (required)
body: object, The request body.
The object takes the form of:
{
"deviceIds": [ # Chrome OS devices to be moved to OU
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(customerId, deviceId, body=None, projection=None, x__xgafv=None)</code>
<pre>Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
deviceId: string, The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) method. (required)
body: object, The request body.
The object takes the form of:
{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).
"activeTimeRanges": [ # List of active time ranges (Read-only).
{
"activeTime": 42, # Duration of usage in milliseconds.
"date": "A String", # Date of usage
},
],
"annotatedAssetId": "A String", # The asset identifier as noted by an administrator or specified during enrollment.
"annotatedLocation": "A String", # The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.
"annotatedUser": "A String", # The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
"autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support
"bootMode": "A String", # The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).
"cpuInfo": [ # Information regarding CPU specs in the device.
{ # CPU specs for a CPU.
"architecture": "A String", # The CPU architecture.
"logicalCpus": [ # Information for the Logical CPUs
{ # Status of a single logical CPU.
"cStates": [ # C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.
{ # Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.
"displayName": "A String", # Name of the state.
"sessionDuration": "A String", # Time spent in the state since the last reboot.
},
],
"currentScalingFrequencyKhz": 42, # Current frequency the CPU is running at.
"idleDuration": "A String", # Idle time since last boot.
"maxScalingFrequencyKhz": 42, # Maximum frequency the CPU is allowed to run at, by policy.
},
],
"maxClockSpeedKhz": 42, # The max CPU clock speed in kHz.
"model": "A String", # The CPU model name.
},
],
"cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only)
{
"cpuTemperatureInfo": [ # List of CPU temperature samples.
{
"label": "A String", # CPU label
"temperature": 42, # Temperature in Celsius degrees.
},
],
"cpuUtilizationPercentageInfo": [
42,
],
"reportTime": "A String", # Date and time the report was received.
},
],
"deviceFiles": [ # List of device files to download (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"deviceId": "A String", # The unique ID of the Chrome device.
"diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes.
{
"volumeInfo": [ # Disk volumes
{
"storageFree": "A String", # Free disk space [in bytes]
"storageTotal": "A String", # Total disk space [in bytes]
"volumeId": "A String", # Volume id
},
],
},
],
"dockMacAddress": "A String", # (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.
"etag": "A String", # ETag of the resource.
"ethernetMacAddress": "A String", # The device's MAC address on the ethernet network interface.
"ethernetMacAddress0": "A String", # (Read-only) MAC address used by the Chromebook鈥檚 internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.
"firmwareVersion": "A String", # The Chrome device's firmware version.
"kind": "admin#directory#chromeosdevice", # The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"lastKnownNetwork": [ # Contains last known network (Read-only)
{ # Information for an ip address.
"ipAddress": "A String", # The IP address.
"wanIpAddress": "A String", # The WAN IP address.
},
],
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response.
"manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format.
"meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).
"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response.
"notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.
"orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number.
"orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"osVersion": "A String", # The Chrome device's operating system version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # List of recent device users, in descending order, by last login time.
{ # List of recent device users, in descending order, by last login time.
"email": "A String", # The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
"type": "A String", # The type of the user.
},
],
"screenshotFiles": [ # List of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"serialNumber": "A String", # The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's *Serial Number* in the *Chrome OS Devices* tab.
"status": "A String", # The status of the device.
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only)
{
"reportTime": "A String", # Date and time the report was received.
"systemRamFreeInfo": [
"A String",
],
},
],
"systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only)
"tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only)
"family": "A String", # TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: "1.2" -> 312e3200 TPM 2.0: "2.0" -> 322e3000
"firmwareVersion": "A String", # TPM firmware version.
"manufacturer": "A String", # TPM manufacturer code.
"specLevel": "A String", # TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.
"tpmModel": "A String", # TPM model number.
"vendorSpecific": "A String", # Vendor-specific information such as Vendor ID.
},
"willAutoRenew": True or False, # Determines if the device will auto renew its support after the support end date. This is a read-only property.
}
projection: string, Restrict information returned to a set of selected fields.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
FULL - Includes all metadata fields
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).
"activeTimeRanges": [ # List of active time ranges (Read-only).
{
"activeTime": 42, # Duration of usage in milliseconds.
"date": "A String", # Date of usage
},
],
"annotatedAssetId": "A String", # The asset identifier as noted by an administrator or specified during enrollment.
"annotatedLocation": "A String", # The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.
"annotatedUser": "A String", # The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
"autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support
"bootMode": "A String", # The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).
"cpuInfo": [ # Information regarding CPU specs in the device.
{ # CPU specs for a CPU.
"architecture": "A String", # The CPU architecture.
"logicalCpus": [ # Information for the Logical CPUs
{ # Status of a single logical CPU.
"cStates": [ # C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.
{ # Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.
"displayName": "A String", # Name of the state.
"sessionDuration": "A String", # Time spent in the state since the last reboot.
},
],
"currentScalingFrequencyKhz": 42, # Current frequency the CPU is running at.
"idleDuration": "A String", # Idle time since last boot.
"maxScalingFrequencyKhz": 42, # Maximum frequency the CPU is allowed to run at, by policy.
},
],
"maxClockSpeedKhz": 42, # The max CPU clock speed in kHz.
"model": "A String", # The CPU model name.
},
],
"cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only)
{
"cpuTemperatureInfo": [ # List of CPU temperature samples.
{
"label": "A String", # CPU label
"temperature": 42, # Temperature in Celsius degrees.
},
],
"cpuUtilizationPercentageInfo": [
42,
],
"reportTime": "A String", # Date and time the report was received.
},
],
"deviceFiles": [ # List of device files to download (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"deviceId": "A String", # The unique ID of the Chrome device.
"diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes.
{
"volumeInfo": [ # Disk volumes
{
"storageFree": "A String", # Free disk space [in bytes]
"storageTotal": "A String", # Total disk space [in bytes]
"volumeId": "A String", # Volume id
},
],
},
],
"dockMacAddress": "A String", # (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.
"etag": "A String", # ETag of the resource.
"ethernetMacAddress": "A String", # The device's MAC address on the ethernet network interface.
"ethernetMacAddress0": "A String", # (Read-only) MAC address used by the Chromebook鈥檚 internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.
"firmwareVersion": "A String", # The Chrome device's firmware version.
"kind": "admin#directory#chromeosdevice", # The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"lastKnownNetwork": [ # Contains last known network (Read-only)
{ # Information for an ip address.
"ipAddress": "A String", # The IP address.
"wanIpAddress": "A String", # The WAN IP address.
},
],
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response.
"manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format.
"meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).
"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response.
"notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.
"orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number.
"orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"osVersion": "A String", # The Chrome device's operating system version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # List of recent device users, in descending order, by last login time.
{ # List of recent device users, in descending order, by last login time.
"email": "A String", # The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
"type": "A String", # The type of the user.
},
],
"screenshotFiles": [ # List of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"serialNumber": "A String", # The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's *Serial Number* in the *Chrome OS Devices* tab.
"status": "A String", # The status of the device.
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only)
{
"reportTime": "A String", # Date and time the report was received.
"systemRamFreeInfo": [
"A String",
],
},
],
"systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only)
"tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only)
"family": "A String", # TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: "1.2" -> 312e3200 TPM 2.0: "2.0" -> 322e3000
"firmwareVersion": "A String", # TPM firmware version.
"manufacturer": "A String", # TPM manufacturer code.
"specLevel": "A String", # TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.
"tpmModel": "A String", # TPM model number.
"vendorSpecific": "A String", # Vendor-specific information such as Vendor ID.
},
"willAutoRenew": True or False, # Determines if the device will auto renew its support after the support end date. This is a read-only property.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(customerId, deviceId, body=None, projection=None, x__xgafv=None)</code>
<pre>Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
deviceId: string, The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) method. (required)
body: object, The request body.
The object takes the form of:
{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).
"activeTimeRanges": [ # List of active time ranges (Read-only).
{
"activeTime": 42, # Duration of usage in milliseconds.
"date": "A String", # Date of usage
},
],
"annotatedAssetId": "A String", # The asset identifier as noted by an administrator or specified during enrollment.
"annotatedLocation": "A String", # The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.
"annotatedUser": "A String", # The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
"autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support
"bootMode": "A String", # The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).
"cpuInfo": [ # Information regarding CPU specs in the device.
{ # CPU specs for a CPU.
"architecture": "A String", # The CPU architecture.
"logicalCpus": [ # Information for the Logical CPUs
{ # Status of a single logical CPU.
"cStates": [ # C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.
{ # Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.
"displayName": "A String", # Name of the state.
"sessionDuration": "A String", # Time spent in the state since the last reboot.
},
],
"currentScalingFrequencyKhz": 42, # Current frequency the CPU is running at.
"idleDuration": "A String", # Idle time since last boot.
"maxScalingFrequencyKhz": 42, # Maximum frequency the CPU is allowed to run at, by policy.
},
],
"maxClockSpeedKhz": 42, # The max CPU clock speed in kHz.
"model": "A String", # The CPU model name.
},
],
"cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only)
{
"cpuTemperatureInfo": [ # List of CPU temperature samples.
{
"label": "A String", # CPU label
"temperature": 42, # Temperature in Celsius degrees.
},
],
"cpuUtilizationPercentageInfo": [
42,
],
"reportTime": "A String", # Date and time the report was received.
},
],
"deviceFiles": [ # List of device files to download (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"deviceId": "A String", # The unique ID of the Chrome device.
"diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes.
{
"volumeInfo": [ # Disk volumes
{
"storageFree": "A String", # Free disk space [in bytes]
"storageTotal": "A String", # Total disk space [in bytes]
"volumeId": "A String", # Volume id
},
],
},
],
"dockMacAddress": "A String", # (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.
"etag": "A String", # ETag of the resource.
"ethernetMacAddress": "A String", # The device's MAC address on the ethernet network interface.
"ethernetMacAddress0": "A String", # (Read-only) MAC address used by the Chromebook鈥檚 internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.
"firmwareVersion": "A String", # The Chrome device's firmware version.
"kind": "admin#directory#chromeosdevice", # The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"lastKnownNetwork": [ # Contains last known network (Read-only)
{ # Information for an ip address.
"ipAddress": "A String", # The IP address.
"wanIpAddress": "A String", # The WAN IP address.
},
],
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response.
"manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format.
"meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).
"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response.
"notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.
"orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number.
"orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"osVersion": "A String", # The Chrome device's operating system version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # List of recent device users, in descending order, by last login time.
{ # List of recent device users, in descending order, by last login time.
"email": "A String", # The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
"type": "A String", # The type of the user.
},
],
"screenshotFiles": [ # List of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"serialNumber": "A String", # The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's *Serial Number* in the *Chrome OS Devices* tab.
"status": "A String", # The status of the device.
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only)
{
"reportTime": "A String", # Date and time the report was received.
"systemRamFreeInfo": [
"A String",
],
},
],
"systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only)
"tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only)
"family": "A String", # TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: "1.2" -> 312e3200 TPM 2.0: "2.0" -> 322e3000
"firmwareVersion": "A String", # TPM firmware version.
"manufacturer": "A String", # TPM manufacturer code.
"specLevel": "A String", # TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.
"tpmModel": "A String", # TPM model number.
"vendorSpecific": "A String", # Vendor-specific information such as Vendor ID.
},
"willAutoRenew": True or False, # Determines if the device will auto renew its support after the support end date. This is a read-only property.
}
projection: string, Restrict information returned to a set of selected fields.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
FULL - Includes all metadata fields
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).
"activeTimeRanges": [ # List of active time ranges (Read-only).
{
"activeTime": 42, # Duration of usage in milliseconds.
"date": "A String", # Date of usage
},
],
"annotatedAssetId": "A String", # The asset identifier as noted by an administrator or specified during enrollment.
"annotatedLocation": "A String", # The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.
"annotatedUser": "A String", # The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
"autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support
"bootMode": "A String", # The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).
"cpuInfo": [ # Information regarding CPU specs in the device.
{ # CPU specs for a CPU.
"architecture": "A String", # The CPU architecture.
"logicalCpus": [ # Information for the Logical CPUs
{ # Status of a single logical CPU.
"cStates": [ # C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.
{ # Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.
"displayName": "A String", # Name of the state.
"sessionDuration": "A String", # Time spent in the state since the last reboot.
},
],
"currentScalingFrequencyKhz": 42, # Current frequency the CPU is running at.
"idleDuration": "A String", # Idle time since last boot.
"maxScalingFrequencyKhz": 42, # Maximum frequency the CPU is allowed to run at, by policy.
},
],
"maxClockSpeedKhz": 42, # The max CPU clock speed in kHz.
"model": "A String", # The CPU model name.
},
],
"cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only)
{
"cpuTemperatureInfo": [ # List of CPU temperature samples.
{
"label": "A String", # CPU label
"temperature": 42, # Temperature in Celsius degrees.
},
],
"cpuUtilizationPercentageInfo": [
42,
],
"reportTime": "A String", # Date and time the report was received.
},
],
"deviceFiles": [ # List of device files to download (Read-only)
{
"createTime": "A String", # Date and time the file was created
"downloadUrl": "A String", # File download URL
"name": "A String", # File name
"type": "A String", # File type
},
],
"deviceId": "A String", # The unique ID of the Chrome device.
"diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes.
{
"volumeInfo": [ # Disk volumes
{
"storageFree": "A String", # Free disk space [in bytes]
"storageTotal": "A String", # Total disk space [in bytes]
"volumeId": "A String", # Volume id
},
],
},
],
"dockMacAddress": "A String", # (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.
"etag": "A String", # ETag of the resource.
"ethernetMacAddress": "A String", # The device's MAC address on the ethernet network interface.
"ethernetMacAddress0": "A String", # (Read-only) MAC address used by the Chromebook鈥檚 internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.
"firmwareVersion": "A String", # The Chrome device's firmware version.
"kind": "admin#directory#chromeosdevice", # The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"lastKnownNetwork": [ # Contains last known network (Read-only)
{ # Information for an ip address.
"ipAddress": "A String", # The IP address.
"wanIpAddress": "A String", # The WAN IP address.
},
],
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response.
"manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format.
"meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).
"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response.
"notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.
"orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number.
"orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).
"osVersion": "A String", # The Chrome device's operating system version.
"platformVersion": "A String", # The Chrome device's platform version.
"recentUsers": [ # List of recent device users, in descending order, by last login time.
{ # List of recent device users, in descending order, by last login time.
"email": "A String", # The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.
"type": "A String", # The type of the user.
},
],
"screenshotFiles": [ # List of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read-only)