-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
GSuiteAdmin.yml
2747 lines (2741 loc) · 109 KB
/
GSuiteAdmin.yml
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
category: IT Services
commonfields:
id: GSuiteAdmin
version: -1
configuration:
- display: User's Service Account JSON
name: user_service_account_json
required: true
type: 4
- display: Admin Email
name: admin_email
required: false
type: 0
additionalinfo: An admin email is required for the Test validation to run. If not configured, then each command can receive an optional admin_email argument.
- display: Trust any certificate (not secure)
name: insecure
required: false
type: 8
- display: Use system proxy settings
name: proxy
required: false
type: 8
description: G Suite or Google Workspace Admin is an integration to perform an action on IT infrastructure, create users, update settings, and more administrative tasks.
display: Google Workspace Admin
name: GSuiteAdmin
script:
commands:
- arguments:
- default: false
description: The unique ID of the customer's Google Workspace Admin account.
isArray: false
name: customer_id
required: true
- default: false
description: Email ID of the G Suite domain admin who acts on behalf of an end-user.
isArray: false
name: admin_email
required: false
secret: false
- description: Whether to show all metadata fields, or only the basic metadata fields (e.g., deviceId, model, type, and status). Default is FULL
isArray: false
name: projection
required: false
auto: PREDEFINED
predefined:
- BASIC
- FULL
- name: query
description: Search string using the format given at https://developers.google.com/admin-sdk/directory/v1/search-operators.
required: false
isArray: false
- auto: PREDEFINED
name: order_by
description: Device property to use for sorting results. Default is STATUS.
required: false
isArray: false
predefined:
- DEVICE_ID
- EMAIL
- LAST_SYNC
- MODEL
- NAME
- OS
- STATUS
- TYPE
- auto: PREDEFINED
name: sort_order
description: Whether to return results in ascending or descending order. Must be used with the order_by parameter. Default is ASCENDING.
required: false
isArray: false
predefined:
- ASCENDING
- DESCENDING
- name: limit
description: The maximum number of records to return from the collection. Default is 50.
required: false
isArray: false
- name: page_token
description: The token of the page.
required: false
isArray: false
- name: page_size
description: The number of requested results per page. Default is 50. Maximum allowed value is 100.
required: false
isArray: false
description: Retrieves a paginated list that includes company-owned mobile devices.
name: gsuite-mobiledevice-list
outputs:
- type: String
contextPath: GSuite.MobileDevices.PageToken.NextPageToken
description: The token of the next page.
- type: Object
contextPath: GSuite.MobileDevices.MobileListObjects
description: A list of mobile device objects.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.kind
description: The type of the API resource.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.etag
description: ETag of the resource.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.resourceId
description: The unique ID the API service uses to identify the mobile device.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.deviceId
description: The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software-generated unique identifier.
- type: List
contextPath: GSuite.MobileDevices.MobileListObjects.name
description: A list of the owner's usernames.
- type: List
contextPath: GSuite.MobileDevices.MobileListObjects.email
description: A list of the owner's email addresses.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.model
description: The mobile device's model name.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.os
description: The mobile device's operating system.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.type
description: The type of mobile device.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.status
description: The mobile device's status.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.hardwareId
description: The IMEI/MEID unique identifier for Android hardware.
- type: Date
contextPath: GSuite.MobileDevices.MobileListObjects.firstSync
description: The date and time the mobile device was initially synchronized with the policy settings in the Admin console.
- type: Date
contextPath: GSuite.MobileDevices.MobileListObjects.lastSync
description: The date and time the mobile device was last synchronized with the policy settings in the Admin console.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.userAgent
description: Gives information about the mobile device such as the operating system version.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.serialNumber
description: The mobile device's serial number.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.imei
description: The mobile device's IMEI number.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.meid
description: The mobile device's MEID number.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.wifiMacAddress
description: The mobile device's MAC address on Wi-Fi networks.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.networkOperator
description: Mobile device mobile or network operator.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.defaultLanguage
description: The default locale used on the mobile device.
- type: Boolean
contextPath: GSuite.MobileDevices.MobileListObjects.managedAccountIsOnOwnerProfile
description: Boolean indicating if this account is on the owner/primary profile.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.deviceCompromisedStatus
description: The compromised device status.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.buildNumber
description: The mobile device's operating system build number.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.kernelVersion
description: The mobile device's kernel version.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.basebandVersion
description: The mobile device's baseband version.
- type: Boolean
contextPath: GSuite.MobileDevices.MobileListObjects.unknownSourcesStatus
description: Unknown sources enabled or disabled on the mobile device.
- type: Boolean
contextPath: GSuite.MobileDevices.MobileListObjects.adbStatus
description: Whether adb (USB debugging) is enabled on the mobile device.
- type: Boolean
contextPath: GSuite.MobileDevices.MobileListObjects.developerOptionsStatus
description: Whether developer options are enabled on the mobile device.
- type: List
contextPath: GSuite.MobileDevices.MobileListObjects.otherAccountsInfo
description: A list of accounts added on the device.
- type: Boolean
contextPath: GSuite.MobileDevices.MobileListObjects.supportsWorkProfile
description: Work profile supported on the mobile device.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.manufacturer
description: Mobile device manufacturer.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.releaseVersion
description: Mobile device release version.
- type: Date
contextPath: GSuite.MobileDevices.MobileListObjects.securityPatchLevel
description: Mobile device security patch level.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.brand
description: Mobile device brand.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.bootloaderVersion
description: Mobile device bootloader version.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.hardware
description: Mobile device hardware.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.encryptionStatus
description: Mobile device encryption status.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.devicePasswordStatus
description: Mobile device password status.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.privilege
description: DM agent permission.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.applications.packageName
description: The application's package name.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.applications.displayName
description: The application's display name.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.applications.versionName
description: The application's version name.
- type: String
contextPath: GSuite.MobileDevices.MobileListObjects.applications.versionCode
description: The application's version code.
- type: List
contextPath: GSuite.MobileDevices.MobileListObjects.applications.permission
description: The list of permissions of this application.
- arguments:
- default: false
description: The unique ID of the customer's Google Workspace Admin account.
isArray: false
name: customer_id
required: true
- default: false
description: Email ID of the G Suite domain admin who acts on behalf of an end-user.
isArray: false
name: admin_email
required: false
secret: false
- description: Whether to show all metadata fields, or only the basic metadata fields (e.g., deviceId, serialNumber, status, and user).
isArray: false
name: projection
required: false
auto: PREDEFINED
predefined:
- BASIC
- FULL
- name: query
description: "Search string in the format given at https://developers.google.com/admin-sdk/directory/v1/list-query-operators."
required: false
isArray: false
- auto: PREDEFINED
name: order_by
description: Device property to use for sorting results.
required: false
isArray: false
predefined:
- ANNOTATED_LOCATION
- ANNOTATED_USER
- LAST_SYNC
- NOTES
- SERIAL_NUMBER
- STATUS
- auto: PREDEFINED
name: sort_order
description: Whether to return results in ascending or descending order. Must be used with the order_by parameter.
required: false
isArray: false
predefined:
- ASCENDING
- DESCENDING
- name: org_unit_path
description: The full path of the organizational unit (without the leading /) or its unique ID.
required: false
isArray: false
- auto: PREDEFINED
name: include_child_org_units
description: Whether to return devices from all child organizational units. If this is set to true, 'org_unit_path' must be provided.
required: false
isArray: false
predefined:
- yes
- no
- name: limit
description: The maximum number of records to return from the collection. Default is 50.
required: false
isArray: false
- name: page
description: The page number.
required: false
isArray: false
- name: page_size
description: The number of requested results per page. Default is 50. Maximum allowed value is 100.
required: false
isArray: false
description: Retrieves a paginated list of company-owned ChromeOS devices.
name: gsuite-chromeosdevice-list
outputs:
- contextPath: GSuite.ChromeOSDevices.PageToken.NextPageToken
description: The token of the next page.
type: String
- contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects
description: A list of ChromeOS device objects.
type: List
- contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.deviceId
description: The unique ID of the ChromeOS device.
type: String
- contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.serialNumber
description: The ChromeOS device serial number entered when the device was enabled.
type: String
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.status
description: Status of the ChromeOS device.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.lastSync
description: The date and time the ChromeOS device was last synchronized with the policy settings in the Admin console.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.supportEndDate
description: The final date the ChromeOS device will be supported.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.annotatedUser
description: The user of the ChromeOS device as noted by the administrator.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.annotatedLocation
description: The address or location of the ChromeOS device as noted by the administrator.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.notes
description: Notes about this ChromeOS device added by the administrator.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.model
description: The ChromeOS device's model information.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.meid
description: The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a ChromeOS device.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.orderNumber
description: The ChromeOS device's order number.
- type: Boolean
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.willAutoRenew
description: Determines if the ChromeOS device will auto renew its support after the support end date.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osVersion
description: The ChromeOS device's operating system version.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.platformVersion
description: The ChromeOS device's platform version.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.firmwareVersion
description: The ChromeOS device's firmware version.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.macAddress
description: The ChromeOS device's wireless MAC address.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.bootMode
description: The boot mode for the ChromeOS device.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.lastEnrollmentTime
description: The date and time the ChromeOS device was last enrolled.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.kind
description: The type of resource.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.recentUsers
description: A list of recent ChromeOS device users, in descending order, by last login time.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.recentUsers.type
description: The type of the user.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.recentUsers.email
description: The user's email address.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.activeTimeRanges
description: A list of active time ranges.
- type: Integer
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.activeTimeRanges.activeTime
description: Duration of usage in milliseconds.
- type: Integer
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.activeTimeRanges.date
description: Date of usage.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.ethernetMacAddress
description: The ChromeOS device's MAC address on the ethernet network interface.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.annotatedAssetId
description: The asset identifier as noted by an administrator or specified during enrollment.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.etag
description: ETag of the resource.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.diskVolumeReports
description: Reports of disk space and other info about mounted/connected volumes.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.diskVolumeReports.volumeInfo
description: Disk volumes.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.diskVolumeReports.volumeInfo.volumeId
description: Volume ID.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.diskVolumeReports.volumeInfo.storageTotal
description: Total disk space [in bytes].
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.diskVolumeReports.volumeInfo.storageFree
description: Free disk space [in bytes].
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.systemRamTotal
description: Total RAM on the ChromeOS device in bytes.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuStatusReports
description: Reports of CPU utilization and temperature.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuStatusReports.reportTime
description: Date and time the report was received.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuStatusReports.cpuUtilizationPercentageInfo
description: The CPU utilization percentage.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuStatusReports.cpuTemperatureInfo
description: A list of CPU temperature samples.
- type: Integer
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuStatusReports.cpuTemperatureInfo.temperature
description: Temperature in Celsius degrees.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuStatusReports.cpuTemperatureInfo.label
description: CPU label.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo
description: Information regarding CPU specs in the device.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.model
description: The CPU model name.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.architecture
description: The CPU architecture.
- type: Integer
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.maxClockSpeedKhz
description: The maximum CPU clock speed in kHz.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus
description: Information for the logical CPUs.
- type: Integer
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus.maxScalingFrequencyKhz
description: Maximum frequency the CPU is allowed to run at, by policy.
- type: Integer
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus.currentScalingFrequencyKhz
description: Current frequency the CPU is running at.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus.idleDuration
description: Idle time since last boot.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus.cStates
description: The power consumption state of the CPU. For more information, see the documentation published by the CPU maker.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus.cStates.displayName
description: Name of the state.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus.cStates.sessionDuration
description: Time spent in the state since the last reboot.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.deviceFiles
description: A list of device files to download.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.deviceFiles.name
description: File name.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.deviceFiles.type
description: File type.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.deviceFiles.downloadUrl
description: File download URL.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.deviceFiles.createTime
description: Date and time the file was created.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.systemRamFreeReports
description: Reports of amounts of available RAM memory.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.systemRamFreeReports.reportTime
description: Date and time the report was received.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.systemRamFreeReports.systemRamFreeInfo
description: Report of free RAM memory.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.lastKnownNetwork
description: Contains last known network.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.lastKnownNetwork.ipAddress
description: The IP address.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.lastKnownNetwork.wanIpAddress
description: The WAN IP address.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.autoUpdateExpiration
description: The timestamp after which the device will stop receiving Chrome updates or support.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.ethernetMacAddress0
description: MAC address used by the Chromebook's 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.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.dockMacAddress
description: 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.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.manufactureDate
description: The date the device was manufactured in yyyy-mm-dd format.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.orgUnitPath
description: 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, /.
- type: Object
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo
description: Trusted Platform Module (TPM).
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo.family
description: TPM family, using the TPM 2.0 style encoding.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo.specLevel
description: TPM specification level.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo.manufacturer
description: TPM manufacturer code.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo.tpmModel
description: TPM model number.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo.firmwareVersion
description: TPM firmware version.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo.vendorSpecific
description: Vendor-specific information such as vendor ID.
- type: List
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.screenshotFiles
description: A list of screenshot files to download.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.screenshotFiles.name
description: File name.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.screenshotFiles.type
description: File type.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.screenshotFiles.downloadUrl
description: File download URL.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.screenshotFiles.createTime
description: Date and time the file was created.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.orgUnitId
description: The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit.
- type: Object
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus
description: The status of the operating system updates for the device.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus.state
description: The update state of an operating system update.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus.targetOsVersion
description: New platform version of the operating system image being downloaded and applied.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus.targetKioskAppVersion
description: New required platform version from the pending updated kiosk app.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus.updateTime
description: Date and time of the last successful operating system update.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus.updateCheckTime
description: Date and time of the last update check.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus.rebootTime
description: Date and time of the last reboot.
- type: String
contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.firstEnrollmentTime
description: Date and time for the first time the device was enrolled.
- arguments:
- default: false
description: The unique ID of the customer's Google Workspace Admin account.
isArray: false
name: customer_id
required: true
- default: false
description: Email ID of the G Suite domain admin who acts on behalf of an end-user.
isArray: false
name: admin_email
required: false
secret: false
- description: The unique ID of the device.
isArray: false
name: resource_id
required: true
- description: The action to be performed on the ChromeOS device.
isArray: false
name: action
required: true
auto: PREDEFINED
predefined:
- deprovision
- disable
- reenable
- pre_provisioned_disable
- pre_provisioned_reenable
- description: Reason for deprovision. This field is required only when the action used is deprovision.
isArray: false
name: deprovision_reason
required: false
auto: PREDEFINED
predefined:
- different_model_replacement
- retiring_device
- same_model_replacement
- upgrade_transfer
description: Executes an action that affects a ChromeOS device. This includes de-provisioning, disabling, and re-enabling devices.
name: gsuite-chromeosdevice-action
- arguments:
- default: false
description: The unique ID of the customer's G Suite account.
isArray: false
name: customer_id
required: true
secret: false
- default: false
description: The unique ID used to identify the mobile device.
isArray: false
name: resource_id
required: true
secret: false
- default: false
description: |-
The action to be performed on the device.
Available Options:
admin_account_wipe - Remotely wipes only G Suite data from the device.
admin_remote_wipe - Remotely wipes all data on the device.
approve - Approves the device.
block - Blocks access to G Suite data on the device.
cancel_remote_wipe_then_activate - Cancels a remote wipe of the device and then reactivates it.
cancel_remote_wipe_then_block - Cancels a remote wipe of the device and then blocks it.
isArray: false
name: action
required: true
secret: false
auto: PREDEFINED
predefined:
- admin_account_wipe
- admin_remote_wipe
- approve
- block
- cancel_remote_wipe_then_activate
- cancel_remote_wipe_then_block
- default: false
description: Email ID of the G Suite domain admin who acts on behalf of an end-user.
isArray: false
name: admin_email
required: false
secret: false
deprecated: false
description: Takes an action that affects a mobile device. For example, remotely wiping a device.
execution: false
name: gsuite-mobile-update
- arguments:
- default: false
description: The unique ID of the customer's G Suite account.
isArray: false
name: customer_id
required: true
secret: false
- default: false
description: The unique ID used to identify the mobile device.
isArray: false
name: resource_id
required: true
secret: false
- default: false
description: Email ID of the G Suite domain admin who acts on behalf of an end-user.
isArray: false
name: admin_email
required: false
secret: false
deprecated: false
description: Removes a mobile device. Note that this does not break the device's sync, it simply removes it from the list of devices connected to the domain. If the device still has a valid login/authentication, it will be added back on it's next successful sync.
execution: false
name: gsuite-mobile-delete
- arguments:
- default: false
description: Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
isArray: false
name: user_key
required: true
secret: false
- default: false
description: The alias email address.
isArray: false
name: alias
required: true
secret: false
- default: false
description: Email ID of the G Suite domain admin who acts on behalf of an end-user.
isArray: false
name: admin_email
required: false
secret: false
deprecated: false
description: Adds an alias.
execution: false
name: gsuite-user-alias-add
outputs:
- contextPath: GSuite.UserAlias.kind
description: The type of the API resource.
type: String
- contextPath: GSuite.UserAlias.id
description: The unique ID for the user.
type: String
- contextPath: GSuite.UserAlias.etag
description: ETag of the resource.
type: String
- contextPath: GSuite.UserAlias.alias
description: The alias email address.
type: String
- arguments:
- default: false
description: The user's first name.
isArray: false
name: first_name
required: true
secret: false
- default: false
description: The user's last name.
isArray: false
name: last_name
required: true
secret: false
- default: false
description: Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. The password will be sent in MD5 hash format.
isArray: false
name: password
required: true
secret: false
- default: false
description: The user's primary email address. The primary_email must be unique and cannot be an alias of another user.
isArray: false
name: primary_email
required: true
secret: false
- default: false
description: User's Country.
isArray: false
name: country
required: false
secret: false
- auto: PREDEFINED
default: false
description: The address type.
isArray: false
name: address_type
predefined:
- home
- other
- work
required: false
secret: false
- default: false
description: The ZIP or postal code, if applicable.
isArray: false
name: postal_code
required: false
secret: false
- auto: PREDEFINED
default: false
description: Set to true, If this is the user's primary address.
isArray: false
name: is_address_primary
predefined:
- 'true'
- 'false'
required: false
secret: false
- default: false
description: For extended addresses, such as an address that includes a sub-region.
isArray: false
name: extended_address
required: false
secret: false
- default: false
description: The abbreviated province or state.
isArray: false
name: region
required: false
secret: false
- default: false
description: The street address, such as 1600 Amphitheatre Parkway. Whitespace within the string is ignored; however, newlines are significant.
isArray: false
name: street_address
required: false
secret: false
- default: false
description: The user's secondary email address.
isArray: false
name: secondary_email_address
required: false
secret: false
- auto: PREDEFINED
default: false
description: The type of the secondary email account.
isArray: false
name: secondary_email_type
predefined:
- home
- other
- work
required: false
secret: false
- auto: PREDEFINED
default: false
description: User's gender.
isArray: false
name: gender
predefined:
- female
- male
- other
- unknown
required: false
secret: false
- auto: PREDEFINED
default: false
description: If true, the user's IP address is on allow list.
isArray: false
name: is_ip_white_listed
predefined:
- 'true'
- 'false'
required: false
secret: false
- auto: PREDEFINED
default: false
description: Content type of note, either plain text or HTML. If not provided, considered as plain text.
isArray: false
name: notes_content_type
predefined:
- text_plain
- text_html
required: false
secret: false
- default: false
description: Contents of notes.
isArray: false
name: notes_value
required: false
secret: false
- default: false
description: A human-readable phone number. It may be in any telephone number format.
isArray: false
name: phone_number
required: false
secret: false
- auto: PREDEFINED
default: false
description: The type of phone number.
isArray: false
name: phone_number_type
predefined:
- assistant
- callback
- car
- company_main
- grand_central
- home
- home_fax
- isdn
- main
- mobile
- other
- other_fax
- pager
- radio
- telex
- tty_tdd
- work
- work_fax
- work_mobile
- work_pager
required: false
secret: false
- auto: PREDEFINED
default: false
description: Indicates if this is the user's primary phone number. A user may only have one primary phone number.
isArray: false
name: is_phone_number_primary
predefined:
- 'true'
- 'false'
required: false
secret: false
- default: false
description: Recovery email of the user.
isArray: false
name: recovery_email
required: false
secret: false
- default: false
description: 'Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.'
isArray: false
name: recovery_phone
required: false
secret: false
- auto: PREDEFINED
default: false
description: Indicates if the user is suspended.
isArray: false
name: suspended
predefined:
- 'true'
- 'false'
required: false
secret: false
- default: false
description: Email ID of the G Suite domain admin who acts on behalf of an end-user.
isArray: false
name: admin_email
required: false
secret: false
deprecated: false
description: Creates a user.
execution: false
name: gsuite-user-create
outputs:
- contextPath: GSuite.User.id
description: The unique ID for the user.
type: String
- contextPath: GSuite.User.primaryEmail
description: The user's primary email address.
type: String
- contextPath: GSuite.User.firstName
description: The user's first name.
type: String
- contextPath: GSuite.User.lastName
description: The user's last name.
type: String
- contextPath: GSuite.User.customerId
description: The unique ID for the customer's G Suite account.
type: String
- contextPath: GSuite.User.gender
description: Gender.
type: String
- contextPath: GSuite.User.suspended
description: Indicates if the user is suspended.
type: Boolean
- contextPath: GSuite.User.notesValue
description: Contents of notes.
type: String
- contextPath: GSuite.User.notesContentType
description: Content type of notes.
type: String
- contextPath: GSuite.User.isAdmin
description: Indicates a user with super administrator privileges.
type: Boolean
- contextPath: GSuite.User.creationTime
description: The time the user's account was created.
type: Date
- contextPath: GSuite.User.phones.value
description: A human-readable phone number. It may be in any telephone number format.
type: String
- contextPath: GSuite.User.phones.type
description: The type of phone number.
type: String
- contextPath: GSuite.User.phones.primary
description: Indicates if this is the user's primary phone number.
type: Boolean
- contextPath: GSuite.User.addresses.type
description: The address type.
type: String
- contextPath: GSuite.User.addresses.country
description: Country.
type: String
- contextPath: GSuite.User.addresses.postalCode
description: The ZIP or postal code.
type: String
- contextPath: GSuite.User.addresses.region
description: The abbreviated province or state.
type: String
- contextPath: GSuite.User.addresses.streetAddress
description: The street address.
type: String
- contextPath: GSuite.User.addresses.extendedAddress
description: For extended addresses, such as an address that includes a sub-region.
type: String
- contextPath: GSuite.User.addresses.primary
description: If this is the user's primary address.
type: Boolean
- contextPath: GSuite.User.emails.address
description: The user's secondary email.
type: String
- contextPath: GSuite.User.emails.type
description: The secondary email type.
type: String
- contextPath: GSuite.User.ipWhitelisted
description: If true, the user's IP address is addded to allow list.
type: Boolean
- contextPath: GSuite.User.recoveryEmail
description: Recovery email of the user.
type: String
- contextPath: GSuite.User.isDelegatedAdmin