-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
cloudresourcemanager-api.json
2301 lines (2301 loc) · 120 KB
/
cloudresourcemanager-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/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
},
"basePath": "",
"baseUrl": "https://cloudresourcemanager.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Resource Manager",
"description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/resource-manager",
"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": "cloudresourcemanager:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://cloudresourcemanager.mtls.googleapis.com/",
"name": "cloudresourcemanager",
"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": {
"folders": {
"methods": {
"clearOrgPolicy": {
"description": "Clears a `Policy` from a resource.",
"flatPath": "v1/folders/{foldersId}:clearOrgPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.folders.clearOrgPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name of the resource for the `Policy` to clear.",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:clearOrgPolicy",
"request": {
"$ref": "ClearOrgPolicyRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getEffectiveOrgPolicy": {
"description": "Gets the effective `Policy` on a resource. This is the result of merging `Policies` in the resource hierarchy. The returned `Policy` will not have an `etag`set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.",
"flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.folders.getEffectiveOrgPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "The name of the resource to start computing the effective `Policy`.",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getEffectiveOrgPolicy",
"request": {
"$ref": "GetEffectiveOrgPolicyRequest"
},
"response": {
"$ref": "OrgPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"getOrgPolicy": {
"description": "Gets a `Policy` on a resource. If no `Policy` is set on the resource, a `Policy` is returned with default values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can be used with `SetOrgPolicy()` to create or update a `Policy` during read-modify-write.",
"flatPath": "v1/folders/{foldersId}:getOrgPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.folders.getOrgPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name of the resource the `Policy` is set on.",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getOrgPolicy",
"request": {
"$ref": "GetOrgPolicyRequest"
},
"response": {
"$ref": "OrgPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"listAvailableOrgPolicyConstraints": {
"description": "Lists `Constraints` that could be applied on the specified resource.",
"flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints",
"httpMethod": "POST",
"id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name of the resource to list `Constraints` for.",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
"request": {
"$ref": "ListAvailableOrgPolicyConstraintsRequest"
},
"response": {
"$ref": "ListAvailableOrgPolicyConstraintsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"listOrgPolicies": {
"description": "Lists all the `Policies` set for a particular resource.",
"flatPath": "v1/folders/{foldersId}:listOrgPolicies",
"httpMethod": "POST",
"id": "cloudresourcemanager.folders.listOrgPolicies",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name of the resource to list Policies for.",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:listOrgPolicies",
"request": {
"$ref": "ListOrgPoliciesRequest"
},
"response": {
"$ref": "ListOrgPoliciesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"setOrgPolicy": {
"description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for that `Constraint` on the resource if one does not exist. Not supplying an `etag` on the request `Policy` results in an unconditional write of the `Policy`.",
"flatPath": "v1/folders/{foldersId}:setOrgPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.folders.setOrgPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Resource name of the resource to attach the `Policy`.",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setOrgPolicy",
"request": {
"$ref": "SetOrgPolicyRequest"
},
"response": {
"$ref": "OrgPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"liens": {
"methods": {
"create": {
"description": "Create a Lien which applies to the resource denoted by the `parent` field. Callers of this method will require permission on the `parent` resource. For example, applying to `projects/1234` requires permission `resourcemanager.projects.updateLiens`. NOTE: Some resources may limit the number of Liens which may be applied.",
"flatPath": "v1/liens",
"httpMethod": "POST",
"id": "cloudresourcemanager.liens.create",
"parameterOrder": [],
"parameters": {},
"path": "v1/liens",
"request": {
"$ref": "Lien"
},
"response": {
"$ref": "Lien"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"delete": {
"description": "Delete a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.updateLiens`.",
"flatPath": "v1/liens/{liensId}",
"httpMethod": "DELETE",
"id": "cloudresourcemanager.liens.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name/identifier of the Lien to delete.",
"location": "path",
"pattern": "^liens/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"get": {
"description": "Retrieve a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`",
"flatPath": "v1/liens/{liensId}",
"httpMethod": "GET",
"id": "cloudresourcemanager.liens.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name/identifier of the Lien.",
"location": "path",
"pattern": "^liens/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Lien"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "List all Liens applied to the `parent` resource. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`.",
"flatPath": "v1/liens",
"httpMethod": "GET",
"id": "cloudresourcemanager.liens.list",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "The maximum number of items to return. This is a suggestion for the server. The server can return fewer liens than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The `next_page_token` value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the resource to list all attached Liens. For example, `projects/1234`. (google.api.field_policy).resource_type annotation is not set since the parent depends on the meta api implementation. This field could be a project or other sub project resources.",
"location": "query",
"type": "string"
}
},
"path": "v1/liens",
"response": {
"$ref": "ListLiensResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "GET",
"id": "cloudresourcemanager.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
},
"organizations": {
"methods": {
"clearOrgPolicy": {
"description": "Clears a `Policy` from a resource.",
"flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.organizations.clearOrgPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name of the resource for the `Policy` to clear.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:clearOrgPolicy",
"request": {
"$ref": "ClearOrgPolicyRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Fetches an Organization resource identified by the specified resource name.",
"flatPath": "v1/organizations/{organizationsId}",
"httpMethod": "GET",
"id": "cloudresourcemanager.organizations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as \"organizations/[organizationId]\". For example, \"organizations/1234\".",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Organization"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"getEffectiveOrgPolicy": {
"description": "Gets the effective `Policy` on a resource. This is the result of merging `Policies` in the resource hierarchy. The returned `Policy` will not have an `etag`set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.",
"flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "The name of the resource to start computing the effective `Policy`.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getEffectiveOrgPolicy",
"request": {
"$ref": "GetEffectiveOrgPolicyRequest"
},
"response": {
"$ref": "OrgPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. \"organizations/123\". Authorization requires the Google IAM permission `resourcemanager.organizations.getIamPolicy` on the specified organization",
"flatPath": "v1/organizations/{organizationsId}:getIamPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.organizations.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"getOrgPolicy": {
"description": "Gets a `Policy` on a resource. If no `Policy` is set on the resource, a `Policy` is returned with default values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can be used with `SetOrgPolicy()` to create or update a `Policy` during read-modify-write.",
"flatPath": "v1/organizations/{organizationsId}:getOrgPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.organizations.getOrgPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name of the resource the `Policy` is set on.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getOrgPolicy",
"request": {
"$ref": "GetOrgPolicyRequest"
},
"response": {
"$ref": "OrgPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"listAvailableOrgPolicyConstraints": {
"description": "Lists `Constraints` that could be applied on the specified resource.",
"flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints",
"httpMethod": "POST",
"id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name of the resource to list `Constraints` for.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
"request": {
"$ref": "ListAvailableOrgPolicyConstraintsRequest"
},
"response": {
"$ref": "ListAvailableOrgPolicyConstraintsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"listOrgPolicies": {
"description": "Lists all the `Policies` set for a particular resource.",
"flatPath": "v1/organizations/{organizationsId}:listOrgPolicies",
"httpMethod": "POST",
"id": "cloudresourcemanager.organizations.listOrgPolicies",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name of the resource to list Policies for.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:listOrgPolicies",
"request": {
"$ref": "ListOrgPoliciesRequest"
},
"response": {
"$ref": "ListOrgPoliciesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"search": {
"description": "Searches Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the results. Search will only return organizations on which the user has the permission `resourcemanager.organizations.get` or has super admin privileges.",
"flatPath": "v1/organizations:search",
"httpMethod": "POST",
"id": "cloudresourcemanager.organizations.search",
"parameterOrder": [],
"parameters": {},
"path": "v1/organizations:search",
"request": {
"$ref": "SearchOrganizationsRequest"
},
"response": {
"$ref": "SearchOrganizationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. \"organizations/123\". Authorization requires the Google IAM permission `resourcemanager.organizations.setIamPolicy` on the specified organization",
"flatPath": "v1/organizations/{organizationsId}:setIamPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.organizations.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setOrgPolicy": {
"description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for that `Constraint` on the resource if one does not exist. Not supplying an `etag` on the request `Policy` results in an unconditional write of the `Policy`.",
"flatPath": "v1/organizations/{organizationsId}:setOrgPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.organizations.setOrgPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Resource name of the resource to attach the `Policy`.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setOrgPolicy",
"request": {
"$ref": "SetOrgPolicyRequest"
},
"response": {
"$ref": "OrgPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. \"organizations/123\". There are no permissions required for making this API call.",
"flatPath": "v1/organizations/{organizationsId}:testIamPermissions",
"httpMethod": "POST",
"id": "cloudresourcemanager.organizations.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
},
"projects": {
"methods": {
"clearOrgPolicy": {
"description": "Clears a `Policy` from a resource.",
"flatPath": "v1/projects/{projectsId}:clearOrgPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.projects.clearOrgPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name of the resource for the `Policy` to clear.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:clearOrgPolicy",
"request": {
"$ref": "ClearOrgPolicyRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Request that a new Project be created. The result is an Operation which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking Operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. Authorization requires the Google IAM permission `resourcemanager.projects.create` on the specified parent for the new project. The parent is identified by a specified ResourceId, which must include both an ID and a type, such as organization. This method does not associate the new project with a billing account. You can set or update the billing account associated with a project using the [`projects.updateBillingInfo`] (/billing/reference/rest/v1/projects/updateBillingInfo) method.",
"flatPath": "v1/projects",
"httpMethod": "POST",
"id": "cloudresourcemanager.projects.create",
"parameterOrder": [],
"parameters": {},
"path": "v1/projects",
"request": {
"$ref": "Project"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have delete permissions for this Project.",
"flatPath": "v1/projects/{projectId}",
"httpMethod": "DELETE",
"id": "cloudresourcemanager.projects.delete",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "The Project ID (for example, `foo-bar-123`). Required.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.",
"flatPath": "v1/projects/{projectId}",
"httpMethod": "GET",
"id": "cloudresourcemanager.projects.get",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Required. The Project ID (for example, `my-project-123`).",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}",
"response": {
"$ref": "Project"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"getAncestry": {
"description": "Gets a list of ancestors in the resource hierarchy for the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.",
"flatPath": "v1/projects/{projectId}:getAncestry",
"httpMethod": "POST",
"id": "cloudresourcemanager.projects.getAncestry",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Required. The Project ID (for example, `my-project-123`).",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}:getAncestry",
"request": {
"$ref": "GetAncestryRequest"
},
"response": {
"$ref": "GetAncestryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"getEffectiveOrgPolicy": {
"description": "Gets the effective `Policy` on a resource. This is the result of merging `Policies` in the resource hierarchy. The returned `Policy` will not have an `etag`set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.",
"flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.projects.getEffectiveOrgPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "The name of the resource to start computing the effective `Policy`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getEffectiveOrgPolicy",
"request": {
"$ref": "GetEffectiveOrgPolicyRequest"
},
"response": {
"$ref": "OrgPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"getIamPolicy": {
"description": "Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist. Authorization requires the Google IAM permission `resourcemanager.projects.getIamPolicy` on the project. For additional information about `resource` (e.g. my-project-id) structure and identification, see [Resource Names](https://cloud.google.com/apis/design/resource_names).",
"flatPath": "v1/projects/{resource}:getIamPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.projects.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"getOrgPolicy": {
"description": "Gets a `Policy` on a resource. If no `Policy` is set on the resource, a `Policy` is returned with default values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can be used with `SetOrgPolicy()` to create or update a `Policy` during read-modify-write.",
"flatPath": "v1/projects/{projectsId}:getOrgPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.projects.getOrgPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name of the resource the `Policy` is set on.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getOrgPolicy",
"request": {
"$ref": "GetOrgPolicyRequest"
},
"response": {
"$ref": "OrgPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Lists Projects that the caller has the `resourcemanager.projects.get` permission on and satisfy the specified filter. This method returns Projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method. NOTE: If the request filter contains a `parent.type` and `parent.id` and the caller has the `resourcemanager.projects.list` permission on the parent, the results will be drawn from an alternate index which provides more consistent results. In future versions of this API, this List method will be split into List and Search to properly capture the behavioral difference.",
"flatPath": "v1/projects",
"httpMethod": "GET",
"id": "cloudresourcemanager.projects.list",
"parameterOrder": [],
"parameters": {
"filter": {
"description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` + `lifecycleState` Some examples of filter queries: | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | | lifecycleState:DELETE_REQUESTED | Only show projects that are pending deletion.| If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: \"parent.type:folder parent.id:123\"). In this case an alternate search index is used which provides more consistent results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.",
"location": "query",
"type": "string"
}
},
"path": "v1/projects",
"response": {
"$ref": "ListProjectsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"listAvailableOrgPolicyConstraints": {
"description": "Lists `Constraints` that could be applied on the specified resource.",
"flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints",
"httpMethod": "POST",
"id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name of the resource to list `Constraints` for.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
"request": {
"$ref": "ListAvailableOrgPolicyConstraintsRequest"
},
"response": {
"$ref": "ListAvailableOrgPolicyConstraintsResponse"
},
"scopes": [