/
chromepolicy-api.json
1282 lines (1282 loc) · 56.3 KB
/
chromepolicy-api.json
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
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/chrome.management.policy": {
"description": "See, edit, create or delete policies applied to Chrome OS and Chrome Browsers managed within your organization"
},
"https://www.googleapis.com/auth/chrome.management.policy.readonly": {
"description": "See policies applied to Chrome OS and Chrome Browsers managed within your organization"
}
}
}
},
"basePath": "",
"baseUrl": "https://chromepolicy.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Chrome Policy",
"description": "The Chrome Policy API is a suite of services that allows Chrome administrators to control the policies applied to their managed Chrome OS devices and Chrome browsers.",
"discoveryVersion": "v1",
"documentationLink": "http://developers.google.com/chrome/policy",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "chromepolicy:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://chromepolicy.mtls.googleapis.com/",
"name": "chromepolicy",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"customers": {
"resources": {
"policies": {
"methods": {
"resolve": {
"description": "Gets the resolved policy values for a list of policies that match a search query.",
"flatPath": "v1/customers/{customersId}/policies:resolve",
"httpMethod": "POST",
"id": "chromepolicy.customers.policies.resolve",
"parameterOrder": [
"customer"
],
"parameters": {
"customer": {
"description": "ID of the G Suite account or literal \"my_customer\" for the customer associated to the request.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+customer}/policies:resolve",
"request": {
"$ref": "GoogleChromePolicyV1ResolveRequest"
},
"response": {
"$ref": "GoogleChromePolicyV1ResolveResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chrome.management.policy",
"https://www.googleapis.com/auth/chrome.management.policy.readonly"
]
}
},
"resources": {
"groups": {
"methods": {
"batchDelete": {
"description": "Delete multiple policy values that are applied to a specific group. All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in `additionalTargetKeyNames`, though the values for those keys may be different. On failure the request will return the error details as part of the google.rpc.Status.",
"flatPath": "v1/customers/{customersId}/policies/groups:batchDelete",
"httpMethod": "POST",
"id": "chromepolicy.customers.policies.groups.batchDelete",
"parameterOrder": [
"customer"
],
"parameters": {
"customer": {
"description": "ID of the Google Workspace account or literal \"my_customer\" for the customer associated to the request.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+customer}/policies/groups:batchDelete",
"request": {
"$ref": "GoogleChromePolicyV1BatchDeleteGroupPoliciesRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/chrome.management.policy"
]
},
"batchModify": {
"description": "Modify multiple policy values that are applied to a specific group. All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in `additionalTargetKeyNames`, though the values for those keys may be different. On failure the request will return the error details as part of the google.rpc.Status.",
"flatPath": "v1/customers/{customersId}/policies/groups:batchModify",
"httpMethod": "POST",
"id": "chromepolicy.customers.policies.groups.batchModify",
"parameterOrder": [
"customer"
],
"parameters": {
"customer": {
"description": "ID of the Google Workspace account or literal \"my_customer\" for the customer associated to the request.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+customer}/policies/groups:batchModify",
"request": {
"$ref": "GoogleChromePolicyV1BatchModifyGroupPoliciesRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/chrome.management.policy"
]
},
"listGroupPriorityOrdering": {
"description": "Retrieve a group priority ordering for an app. The target app must be supplied in `additionalTargetKeyNames` in the PolicyTargetKey. On failure the request will return the error details as part of the google.rpc.Status.",
"flatPath": "v1/customers/{customersId}/policies/groups:listGroupPriorityOrdering",
"httpMethod": "POST",
"id": "chromepolicy.customers.policies.groups.listGroupPriorityOrdering",
"parameterOrder": [
"customer"
],
"parameters": {
"customer": {
"description": "Required. ID of the Google Workspace account or literal \"my_customer\" for the customer associated to the request.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+customer}/policies/groups:listGroupPriorityOrdering",
"request": {
"$ref": "GoogleChromePolicyV1ListGroupPriorityOrderingRequest"
},
"response": {
"$ref": "GoogleChromePolicyV1ListGroupPriorityOrderingResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chrome.management.policy",
"https://www.googleapis.com/auth/chrome.management.policy.readonly"
]
},
"updateGroupPriorityOrdering": {
"description": "Update a group priority ordering for an app. The target app must be supplied in `additionalTargetKeyNames` in the PolicyTargetKey. On failure the request will return the error details as part of the google.rpc.Status.",
"flatPath": "v1/customers/{customersId}/policies/groups:updateGroupPriorityOrdering",
"httpMethod": "POST",
"id": "chromepolicy.customers.policies.groups.updateGroupPriorityOrdering",
"parameterOrder": [
"customer"
],
"parameters": {
"customer": {
"description": "Required. ID of the Google Workspace account or literal \"my_customer\" for the customer associated to the request.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+customer}/policies/groups:updateGroupPriorityOrdering",
"request": {
"$ref": "GoogleChromePolicyV1UpdateGroupPriorityOrderingRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/chrome.management.policy"
]
}
}
},
"orgunits": {
"methods": {
"batchInherit": {
"description": "Modify multiple policy values that are applied to a specific org unit so that they now inherit the value from a parent (if applicable). All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in `additionalTargetKeyNames`, though the values for those keys may be different. On failure the request will return the error details as part of the google.rpc.Status.",
"flatPath": "v1/customers/{customersId}/policies/orgunits:batchInherit",
"httpMethod": "POST",
"id": "chromepolicy.customers.policies.orgunits.batchInherit",
"parameterOrder": [
"customer"
],
"parameters": {
"customer": {
"description": "ID of the G Suite account or literal \"my_customer\" for the customer associated to the request.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+customer}/policies/orgunits:batchInherit",
"request": {
"$ref": "GoogleChromePolicyV1BatchInheritOrgUnitPoliciesRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/chrome.management.policy"
]
},
"batchModify": {
"description": "Modify multiple policy values that are applied to a specific org unit. All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in `additionalTargetKeyNames`, though the values for those keys may be different. On failure the request will return the error details as part of the google.rpc.Status.",
"flatPath": "v1/customers/{customersId}/policies/orgunits:batchModify",
"httpMethod": "POST",
"id": "chromepolicy.customers.policies.orgunits.batchModify",
"parameterOrder": [
"customer"
],
"parameters": {
"customer": {
"description": "ID of the G Suite account or literal \"my_customer\" for the customer associated to the request.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+customer}/policies/orgunits:batchModify",
"request": {
"$ref": "GoogleChromePolicyV1BatchModifyOrgUnitPoliciesRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/chrome.management.policy"
]
}
}
}
}
},
"policySchemas": {
"methods": {
"get": {
"description": "Get a specific policy schema for a customer by its resource name.",
"flatPath": "v1/customers/{customersId}/policySchemas/{policySchemasId}",
"httpMethod": "GET",
"id": "chromepolicy.customers.policySchemas.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The policy schema resource name to query.",
"location": "path",
"pattern": "^customers/[^/]+/policySchemas/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleChromePolicyV1PolicySchema"
},
"scopes": [
"https://www.googleapis.com/auth/chrome.management.policy",
"https://www.googleapis.com/auth/chrome.management.policy.readonly"
]
},
"list": {
"description": "Gets a list of policy schemas that match a specified filter value for a given customer.",
"flatPath": "v1/customers/{customersId}/policySchemas",
"httpMethod": "GET",
"id": "chromepolicy.customers.policySchemas.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The schema filter used to find a particular schema based on fields like its resource name, description and `additionalTargetKeyNames`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of policy schemas to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The page token used to retrieve a specific page of the listing request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The customer for which the listing request will apply.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/policySchemas",
"response": {
"$ref": "GoogleChromePolicyV1ListPolicySchemasResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chrome.management.policy",
"https://www.googleapis.com/auth/chrome.management.policy.readonly"
]
}
}
}
}
},
"media": {
"methods": {
"upload": {
"description": "Creates an enterprise file from the content provided by user. Returns a public download url for end user.",
"flatPath": "v1/customers/{customersId}/policies/files:uploadPolicyFile",
"httpMethod": "POST",
"id": "chromepolicy.media.upload",
"mediaUpload": {
"accept": [
"*/*"
],
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/v1/{+customer}/policies/files:uploadPolicyFile"
}
}
},
"parameterOrder": [
"customer"
],
"parameters": {
"customer": {
"description": "Required. The customer for which the file upload will apply.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+customer}/policies/files:uploadPolicyFile",
"request": {
"$ref": "GoogleChromePolicyV1UploadPolicyFileRequest"
},
"response": {
"$ref": "GoogleChromePolicyV1UploadPolicyFileResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chrome.management.policy"
],
"supportsMediaUpload": true
}
}
}
},
"revision": "20220816",
"rootUrl": "https://chromepolicy.googleapis.com/",
"schemas": {
"ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle": {
"id": "ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle",
"properties": {
"description": {
"description": "Description about current life cycle.",
"type": "string"
},
"endSupport": {
"$ref": "GoogleTypeDate",
"description": "End supporting date for current policy."
},
"policyApiLifecycleStage": {
"description": "Indicate current life cycle stage of the policy API.",
"enum": [
"API_UNSPECIFIED",
"API_PREVIEW",
"API_DEVELOPMENT",
"API_CURRENT",
"API_DEPRECATED"
],
"enumDescriptions": [
"unspecified.",
"Policy is not working yet, but giving developers heads up on format. This stage can transfer to API_DEVELOPEMNT or API_CURRENT.",
"Policy can change format in backward incompatible way (breaking change). This stage can transfer to API_CURRENT or API_DEPRECATED. This could be used for policies launched only to TTs or launched to selected customers for emergency usage.",
"Policy in official format. Policy can change format in backward compatible way (non-breaking change). Example: this policy can introduce a new field, which is considered non-breaking change, when field masks are properly utilized. This stage can transfer to API_DEPRECATED.",
"Please stop using this policy. This policy is deprecated and may/will be removed in the future. Most likely a new policy was introduced to replace this one."
],
"type": "string"
}
},
"type": "object"
},
"GoogleChromePolicyV1AdditionalTargetKeyName": {
"description": "Additional key names that will be used to identify the target of the policy value.",
"id": "GoogleChromePolicyV1AdditionalTargetKeyName",
"properties": {
"key": {
"description": "Key name.",
"type": "string"
},
"keyDescription": {
"description": "Key description.",
"type": "string"
}
},
"type": "object"
},
"GoogleChromePolicyV1BatchDeleteGroupPoliciesRequest": {
"description": "Request message for specifying that multiple policy values will be deleted.",
"id": "GoogleChromePolicyV1BatchDeleteGroupPoliciesRequest",
"properties": {
"requests": {
"description": "List of policies that will be deleted as defined by the `requests`. All requests in the list must follow these restrictions: 1. All schemas in the list must have the same root namespace. 2. All `policyTargetKey.targetResource` values must point to a group resource. 3. All `policyTargetKey` values must have the same `app_id` key name in the `additionalTargetKeys`. 4. No two modification requests can reference the same `policySchema` + ` policyTargetKey` pair. ",
"items": {
"$ref": "GoogleChromePolicyV1DeleteGroupPolicyRequest"
},
"type": "array"
}
},
"type": "object"
},
"GoogleChromePolicyV1BatchInheritOrgUnitPoliciesRequest": {
"description": "Request message for specifying that multiple policy values inherit their value from their parents.",
"id": "GoogleChromePolicyV1BatchInheritOrgUnitPoliciesRequest",
"properties": {
"requests": {
"description": "List of policies that have to inherit their values as defined by the `requests`. All requests in the list must follow these restrictions: 1. All schemas in the list must have the same root namespace. 2. All `policyTargetKey.targetResource` values must point to an org unit resource. 3. All `policyTargetKey` values must have the same key names in the ` additionalTargetKeys`. This also means if one of the targets has an empty `additionalTargetKeys` map, all of the targets must have an empty `additionalTargetKeys` map. 4. No two modification requests can reference the same `policySchema` + ` policyTargetKey` pair. ",
"items": {
"$ref": "GoogleChromePolicyV1InheritOrgUnitPolicyRequest"
},
"type": "array"
}
},
"type": "object"
},
"GoogleChromePolicyV1BatchModifyGroupPoliciesRequest": {
"description": "Request message for modifying multiple policy values for a specific group-based target.",
"id": "GoogleChromePolicyV1BatchModifyGroupPoliciesRequest",
"properties": {
"requests": {
"description": "List of policies to modify as defined by the `requests`. All requests in the list must follow these restrictions: 1. All schemas in the list must have the same root namespace. 2. All `policyTargetKey.targetResource` values must point to a group resource. 3. All `policyTargetKey` values must have the same `app_id` key name in the `additionalTargetKeys`. 4. No two modification requests can reference the same `policySchema` + ` policyTargetKey` pair. ",
"items": {
"$ref": "GoogleChromePolicyV1ModifyGroupPolicyRequest"
},
"type": "array"
}
},
"type": "object"
},
"GoogleChromePolicyV1BatchModifyOrgUnitPoliciesRequest": {
"description": "Request message for modifying multiple policy values for a specific target.",
"id": "GoogleChromePolicyV1BatchModifyOrgUnitPoliciesRequest",
"properties": {
"requests": {
"description": "List of policies to modify as defined by the `requests`. All requests in the list must follow these restrictions: 1. All schemas in the list must have the same root namespace. 2. All `policyTargetKey.targetResource` values must point to an org unit resource. 3. All `policyTargetKey` values must have the same key names in the ` additionalTargetKeys`. This also means if one of the targets has an empty `additionalTargetKeys` map, all of the targets must have an empty `additionalTargetKeys` map. 4. No two modification requests can reference the same `policySchema` + ` policyTargetKey` pair. ",
"items": {
"$ref": "GoogleChromePolicyV1ModifyOrgUnitPolicyRequest"
},
"type": "array"
}
},
"type": "object"
},
"GoogleChromePolicyV1DeleteGroupPolicyRequest": {
"description": "Request parameters for deleting the policy value of a specific group target.",
"id": "GoogleChromePolicyV1DeleteGroupPolicyRequest",
"properties": {
"policySchema": {
"description": "The fully qualified name of the policy schema that is being inherited.",
"type": "string"
},
"policyTargetKey": {
"$ref": "GoogleChromePolicyV1PolicyTargetKey",
"description": "Required. The key of the target for which we want to modify a policy. The target resource must point to a Group."
}
},
"type": "object"
},
"GoogleChromePolicyV1InheritOrgUnitPolicyRequest": {
"description": "Request parameters for inheriting policy value of a specific org unit target from the policy value of its parent org unit.",
"id": "GoogleChromePolicyV1InheritOrgUnitPolicyRequest",
"properties": {
"policySchema": {
"description": "The fully qualified name of the policy schema that is being inherited.",
"type": "string"
},
"policyTargetKey": {
"$ref": "GoogleChromePolicyV1PolicyTargetKey",
"description": "Required. The key of the target for which we want to modify a policy. The target resource must point to an Org Unit."
}
},
"type": "object"
},
"GoogleChromePolicyV1ListGroupPriorityOrderingRequest": {
"description": "Request message for listing the group priority ordering of an app.",
"id": "GoogleChromePolicyV1ListGroupPriorityOrderingRequest",
"properties": {
"policyNamespace": {
"description": "Required. The namespace of the policy type for the request.",
"type": "string"
},
"policyTargetKey": {
"$ref": "GoogleChromePolicyV1PolicyTargetKey",
"description": "Required. The key of the target for which we want to retrieve the group priority ordering. The target resource must point to an app."
}
},
"type": "object"
},
"GoogleChromePolicyV1ListGroupPriorityOrderingResponse": {
"description": "Response message for listing the group priority ordering of an app.",
"id": "GoogleChromePolicyV1ListGroupPriorityOrderingResponse",
"properties": {
"groupIds": {
"description": "Output only. The group IDs, in priority ordering.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"policyNamespace": {
"description": "Output only. The namespace of the policy type of the group IDs.",
"readOnly": true,
"type": "string"
},
"policyTargetKey": {
"$ref": "GoogleChromePolicyV1PolicyTargetKey",
"description": "Output only. The target resource for which the group priority ordering has been retrieved.",
"readOnly": true
}
},
"type": "object"
},
"GoogleChromePolicyV1ListPolicySchemasResponse": {
"description": "Response message for listing policy schemas that match a filter.",
"id": "GoogleChromePolicyV1ListPolicySchemasResponse",
"properties": {
"nextPageToken": {
"description": "The page token used to get the next page of policy schemas.",
"type": "string"
},
"policySchemas": {
"description": "The list of policy schemas that match the query.",
"items": {
"$ref": "GoogleChromePolicyV1PolicySchema"
},
"type": "array"
}
},
"type": "object"
},
"GoogleChromePolicyV1ModifyGroupPolicyRequest": {
"description": "Request parameters for modifying a policy value for a specific group target.",
"id": "GoogleChromePolicyV1ModifyGroupPolicyRequest",
"properties": {
"policyTargetKey": {
"$ref": "GoogleChromePolicyV1PolicyTargetKey",
"description": "Required. The key of the target for which we want to modify a policy. The target resource must point to a Group."
},
"policyValue": {
"$ref": "GoogleChromePolicyV1PolicyValue",
"description": "The new value for the policy."
},
"updateMask": {
"description": "Required. Policy fields to update. Only fields in this mask will be updated; other fields in `policy_value` will be ignored (even if they have values). If a field is in this list it must have a value in 'policy_value'.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleChromePolicyV1ModifyOrgUnitPolicyRequest": {
"description": "Request parameters for modifying a policy value for a specific org unit target.",
"id": "GoogleChromePolicyV1ModifyOrgUnitPolicyRequest",
"properties": {
"policyTargetKey": {
"$ref": "GoogleChromePolicyV1PolicyTargetKey",
"description": "Required. The key of the target for which we want to modify a policy. The target resource must point to an Org Unit."
},
"policyValue": {
"$ref": "GoogleChromePolicyV1PolicyValue",
"description": "The new value for the policy."
},
"updateMask": {
"description": "Required. Policy fields to update. Only fields in this mask will be updated; other fields in `policy_value` will be ignored (even if they have values). If a field is in this list it must have a value in 'policy_value'.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleChromePolicyV1PolicySchema": {
"description": "Resource representing a policy schema. Next ID: 13",
"id": "GoogleChromePolicyV1PolicySchema",
"properties": {
"accessRestrictions": {
"description": "Output only. Specific access restrictions related to this policy.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"additionalTargetKeyNames": {
"description": "Output only. Additional key names that will be used to identify the target of the policy value. When specifying a `policyTargetKey`, each of the additional keys specified here will have to be included in the `additionalTargetKeys` map.",
"items": {
"$ref": "GoogleChromePolicyV1AdditionalTargetKeyName"
},
"readOnly": true,
"type": "array"
},
"definition": {
"$ref": "Proto2FileDescriptorProto",
"description": "Schema definition using proto descriptor."
},
"fieldDescriptions": {
"description": "Output only. Detailed description of each field that is part of the schema.",
"items": {
"$ref": "GoogleChromePolicyV1PolicySchemaFieldDescription"
},
"readOnly": true,
"type": "array"
},
"name": {
"description": "Format: name=customers/{customer}/policySchemas/{schema_namespace}",
"type": "string"
},
"notices": {
"description": "Output only. Special notice messages related to setting certain values in certain fields in the schema.",
"items": {
"$ref": "GoogleChromePolicyV1PolicySchemaNoticeDescription"
},
"readOnly": true,
"type": "array"
},
"policyApiLifecycle": {
"$ref": "ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle",
"description": "Output only. Current lifecycle information.",
"readOnly": true
},
"policyApiLifeycle": {
"$ref": "ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle",
"description": "Deprecated field because of typo."
},
"policyDescription": {
"description": "Output only. Description about the policy schema for user consumption.",
"readOnly": true,
"type": "string"
},
"schemaName": {
"description": "Output only. The fully qualified name of the policy schema. This value is used to fill the field `policy_schema` in PolicyValue when calling BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies or BatchDeleteGroupPolicies.",
"readOnly": true,
"type": "string"
},
"supportUri": {
"description": "Output only. URI to related support article for this schema.",
"readOnly": true,
"type": "string"
},
"validTargetResources": {
"description": "Output only. Information about applicable target resources for the policy.",
"items": {
"enum": [
"TARGET_RESOURCE_UNSPECIFIED",
"ORG_UNIT",
"GROUP"
],
"enumDescriptions": [
"Unspecified target resource.",
"Organizational Unit target resource.",
"Group target resource."
],
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleChromePolicyV1PolicySchemaFieldDependencies": {
"description": "The field and the value it must have for another field to be allowed to be set.",
"id": "GoogleChromePolicyV1PolicySchemaFieldDependencies",
"properties": {
"sourceField": {
"description": "The source field which this field depends on.",
"type": "string"
},
"sourceFieldValue": {
"description": "The value which the source field must have for this field to be allowed to be set.",
"type": "string"
}
},
"type": "object"
},
"GoogleChromePolicyV1PolicySchemaFieldDescription": {
"description": "Provides detailed information for a particular field that is part of a PolicySchema.",
"id": "GoogleChromePolicyV1PolicySchemaFieldDescription",
"properties": {
"description": {
"description": "Output only. The description for the field.",
"readOnly": true,
"type": "string"
},
"field": {
"description": "Output only. The name of the field for associated with this description.",
"readOnly": true,
"type": "string"
},
"fieldDependencies": {
"description": "Output only. Provides a list of fields and values. At least one of the fields must have the corresponding value in order for this field to be allowed to be set.",
"items": {
"$ref": "GoogleChromePolicyV1PolicySchemaFieldDependencies"
},
"readOnly": true,
"type": "array"
},
"inputConstraint": {
"description": "Output only. Any input constraints associated on the values for the field.",
"readOnly": true,
"type": "string"
},
"knownValueDescriptions": {
"description": "Output only. If the field has a set of known values, this field will provide a description for these values.",
"items": {
"$ref": "GoogleChromePolicyV1PolicySchemaFieldKnownValueDescription"
},
"readOnly": true,
"type": "array"
},
"nestedFieldDescriptions": {
"description": "Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields.",
"items": {
"$ref": "GoogleChromePolicyV1PolicySchemaFieldDescription"
},
"readOnly": true,
"type": "array"
},
"requiredItems": {
"description": "Output only. Provides a list of fields that are required to be set if this field has a certain value.",
"items": {
"$ref": "GoogleChromePolicyV1PolicySchemaRequiredItems"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleChromePolicyV1PolicySchemaFieldKnownValueDescription": {
"description": "Provides detailed information about a known value that is allowed for a particular field in a PolicySchema.",
"id": "GoogleChromePolicyV1PolicySchemaFieldKnownValueDescription",
"properties": {
"description": {
"description": "Output only. Additional description for this value.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Output only. The string represenstation of the value that can be set for the field.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleChromePolicyV1PolicySchemaNoticeDescription": {
"description": "Provides special notice messages related to a particular value in a field that is part of a PolicySchema.",
"id": "GoogleChromePolicyV1PolicySchemaNoticeDescription",
"properties": {
"acknowledgementRequired": {
"description": "Output only. Whether the user needs to acknowledge the notice message before the value can be set.",
"readOnly": true,
"type": "boolean"
},
"field": {
"description": "Output only. The field name associated with the notice.",
"readOnly": true,
"type": "string"
},
"noticeMessage": {
"description": "Output only. The notice message associate with the value of the field.",
"readOnly": true,
"type": "string"
},
"noticeValue": {
"description": "Output only. The value of the field that has a notice. When setting the field to this value, the user may be required to acknowledge the notice message in order for the value to be set.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleChromePolicyV1PolicySchemaRequiredItems": {
"description": "The fields that will become required based on the value of this field.",
"id": "GoogleChromePolicyV1PolicySchemaRequiredItems",
"properties": {
"fieldConditions": {
"description": "The value(s) of the field that provoke required field enforcement. An empty field_conditions implies that any value assigned to this field will provoke required field enforcement.",
"items": {
"type": "string"
},
"type": "array"
},
"requiredFields": {
"description": "The fields that are required as a consequence of the field conditions.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleChromePolicyV1PolicyTargetKey": {
"description": "The key used to identify the target on which the policy will be applied.",
"id": "GoogleChromePolicyV1PolicyTargetKey",
"properties": {
"additionalTargetKeys": {
"additionalProperties": {
"type": "string"
},
"description": "Map containing the additional target key name and value pairs used to further identify the target of the policy.",
"type": "object"
},
"targetResource": {
"description": "The target resource on which this policy is applied. The following resources are supported: * Organizational Unit (\"orgunits/{orgunit_id}\") * Group (\"groups/{group_id}\")",
"type": "string"
}
},
"type": "object"
},
"GoogleChromePolicyV1PolicyValue": {
"description": "A particular value for a policy managed by the service.",
"id": "GoogleChromePolicyV1PolicyValue",
"properties": {
"policySchema": {
"description": "The fully qualified name of the policy schema associated with this policy.",
"type": "string"
},
"value": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The value of the policy that is compatible with the schema that it is associated with.",
"type": "object"
}
},
"type": "object"
},
"GoogleChromePolicyV1ResolveRequest": {
"description": "Request message for getting the resolved policy value for a specific target.",
"id": "GoogleChromePolicyV1ResolveRequest",
"properties": {
"pageSize": {
"description": "The maximum number of policies to return, defaults to 100 and has a maximum of 1000.",
"format": "int32",
"type": "integer"
},
"pageToken": {
"description": "The page token used to retrieve a specific page of the request.",
"type": "string"
},
"policySchemaFilter": {
"description": "The schema filter to apply to the resolve request. Specify a schema name to view a particular schema, for example: chrome.users.ShowLogoutButton Wildcards are supported, but only in the leaf portion of the schema name. Wildcards cannot be used in namespace directly. Please read https://developers.google.com/chrome/policy/guides/policy-schemas for details on schema namepsaces. For example: Valid: \"chrome.users.*\", \"chrome.users.apps.*\", \"chrome.printers.*\" Invalid: \"*\", \"*.users\", \"chrome.*\", \"chrome.*.apps.*\"",
"type": "string"
},
"policyTargetKey": {
"$ref": "GoogleChromePolicyV1PolicyTargetKey",
"description": "Required. The key of the target resource on which the policies should be resolved. The target resource must point to an Org Unit."
}
},
"type": "object"
},
"GoogleChromePolicyV1ResolveResponse": {
"description": "Response message for getting the resolved policy value for a specific target.",
"id": "GoogleChromePolicyV1ResolveResponse",
"properties": {
"nextPageToken": {
"description": "The page token used to get the next set of resolved policies found by the request.",
"type": "string"
},
"resolvedPolicies": {
"description": "The list of resolved policies found by the resolve request.",
"items": {
"$ref": "GoogleChromePolicyV1ResolvedPolicy"
},
"type": "array"
}
},
"type": "object"
},
"GoogleChromePolicyV1ResolvedPolicy": {
"description": "The resolved value of a policy for a given target.",
"id": "GoogleChromePolicyV1ResolvedPolicy",
"properties": {
"addedSourceKey": {
"$ref": "GoogleChromePolicyV1PolicyTargetKey",
"description": "Output only. The added source key establishes at which level an entity was explicitly added for management. This is useful for certain type of policies that are only applied if they are explicitly added for management. For example: apps and networks. An entity can only be deleted from management in an Organizational Unit that it was explicitly added to. If this is not present it means that the policy is managed without the need to explicitly add an entity, for example: standard user or device policies.",
"readOnly": true
},
"sourceKey": {
"$ref": "GoogleChromePolicyV1PolicyTargetKey",
"description": "Output only. The source resource from which this policy value is obtained. May be the same as `targetKey` if the policy is directly modified on the target, otherwise it would be another resource from which the policy gets its value (if applicable). If not present, the source is the default value for the customer.",
"readOnly": true
},
"targetKey": {
"$ref": "GoogleChromePolicyV1PolicyTargetKey",
"description": "Output only. The target resource for which the resolved policy value applies.",
"readOnly": true
},
"value": {
"$ref": "GoogleChromePolicyV1PolicyValue",