/
assuredworkloads-api.json
1336 lines (1336 loc) · 64.3 KB
/
assuredworkloads-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."
}
}
}
},
"basePath": "",
"baseUrl": "https://assuredworkloads.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Assuredworkloads",
"description": "",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/learnmoreurl",
"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": "assuredworkloads:v1beta1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://assuredworkloads.mtls.googleapis.com/",
"name": "assuredworkloads",
"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": {
"organizations": {
"resources": {
"locations": {
"resources": {
"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": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "assuredworkloads.organizations.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "assuredworkloads.organizations.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"workloads": {
"methods": {
"create": {
"description": "Creates Assured Workload.",
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads",
"httpMethod": "POST",
"id": "assuredworkloads.organizations.locations.workloads.create",
"parameterOrder": [
"parent"
],
"parameters": {
"externalId": {
"description": "Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/workloads",
"request": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.",
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}",
"httpMethod": "DELETE",
"id": "assuredworkloads.organizations.locations.workloads.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets Assured Workload associated with a CRM Node",
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}",
"httpMethod": "GET",
"id": "assuredworkloads.organizations.locations.workloads.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists Assured Workloads under a CRM Node.",
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads",
"httpMethod": "GET",
"id": "assuredworkloads.organizations.locations.workloads.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/workloads",
"response": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.",
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}",
"httpMethod": "PATCH",
"id": "assuredworkloads.organizations.locations.workloads.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The list of fields to be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload"
},
"response": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"restrictAllowedResources": {
"description": "Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.",
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources",
"httpMethod": "POST",
"id": "assuredworkloads.organizations.locations.workloads.restrictAllowedResources",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:restrictAllowedResources",
"request": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest"
},
"response": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"organizations": {
"resources": {
"locations": {
"resources": {
"workloads": {
"methods": {
"analyzeWorkloadMove": {
"description": "Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.",
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/organizations/{organizationsId1}/locations/{locationsId1}/workloads/{workloadsId1}:analyzeWorkloadMove",
"httpMethod": "GET",
"id": "assuredworkloads.organizations.locations.workloads.organizations.locations.workloads.analyzeWorkloadMove",
"parameterOrder": [
"source",
"target"
],
"parameters": {
"project": {
"description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.",
"location": "query",
"type": "string"
},
"source": {
"description": "The source type is a project-based workload. Specify the workloads's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-1\"",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
"required": true,
"type": "string"
},
"target": {
"description": "Required. The resource ID of the folder-based destination workload. This workload is where the source project will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+source}/{+target}:analyzeWorkloadMove",
"response": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
},
"violations": {
"methods": {
"acknowledge": {
"description": "Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.",
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge",
"httpMethod": "POST",
"id": "assuredworkloads.organizations.locations.workloads.violations.acknowledge",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:acknowledge",
"request": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest"
},
"response": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieves Assured Workload Violation based on ID.",
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}",
"httpMethod": "GET",
"id": "assuredworkloads.organizations.locations.workloads.violations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1Violation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`",
"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations",
"httpMethod": "GET",
"id": "assuredworkloads.organizations.locations.workloads.violations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. A custom filter for filtering by the Violations properties.",
"location": "query",
"type": "string"
},
"interval.endTime": {
"description": "The end of the time window.",
"format": "google-datetime",
"location": "query",
"type": "string"
},
"interval.startTime": {
"description": "The start of the time window.",
"format": "google-datetime",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token returned from previous request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/violations",
"response": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
}
},
"projects": {
"resources": {
"organizations": {
"resources": {
"locations": {
"resources": {
"workloads": {
"methods": {
"analyzeWorkloadMove": {
"description": "Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.",
"flatPath": "v1beta1/projects/{projectsId}/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove",
"httpMethod": "GET",
"id": "assuredworkloads.projects.organizations.locations.workloads.analyzeWorkloadMove",
"parameterOrder": [
"project",
"target"
],
"parameters": {
"project": {
"description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"source": {
"description": "The source type is a project-based workload. Specify the workloads's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-1\"",
"location": "query",
"type": "string"
},
"target": {
"description": "Required. The resource ID of the folder-based destination workload. This workload is where the source project will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+project}/{+target}:analyzeWorkloadMove",
"response": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
}
}
},
"revision": "20221104",
"rootUrl": "https://assuredworkloads.googleapis.com/",
"schemas": {
"GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": {
"description": "Request for acknowledging the violation Next Id: 4",
"id": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest",
"properties": {
"comment": {
"description": "Required. Business justification explaining the need for violation acknowledgement",
"type": "string"
},
"nonCompliantOrgPolicy": {
"description": "Optional. This field is deprecated and will be removed in future version of the API. Name of the OrgPolicy which was modified with non-compliant change and resulted in this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationResponse": {
"description": "Response for violation acknowledgement",
"id": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationResponse",
"properties": {},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse": {
"description": "A response that includes the analysis of the hypothetical resource move.",
"id": "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse",
"properties": {
"blockers": {
"description": "A list of blockers that should be addressed before moving the source project or project-based workload to the destination folder-based workload.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse": {
"description": "Response of ListViolations endpoint.",
"id": "GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse",
"properties": {
"nextPageToken": {
"description": "The next page token. Returns empty if reached the last page.",
"type": "string"
},
"violations": {
"description": "List of Violations under a Workload.",
"items": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1Violation"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse": {
"description": "Response of ListWorkloads endpoint.",
"id": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse",
"properties": {
"nextPageToken": {
"description": "The next page token. Return empty if reached the last page.",
"type": "string"
},
"workloads": {
"description": "List of Workloads under a given parent.",
"items": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest": {
"description": "Request for restricting list of available resources in Workload environment.",
"id": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest",
"properties": {
"restrictionType": {
"description": "Required. The type of restriction for using gcp products in the Workload environment.",
"enum": [
"RESTRICTION_TYPE_UNSPECIFIED",
"ALLOW_ALL_GCP_RESOURCES",
"ALLOW_COMPLIANT_RESOURCES",
"APPEND_COMPLIANT_RESOURCES"
],
"enumDescriptions": [
"Unknown restriction type.",
"Allow the use all of all gcp products, irrespective of the compliance posture. This effectively removes gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder.",
"Based on Workload's compliance regime, allowed list changes. See - https://cloud.google.com/assured-workloads/docs/supported-products for the list of supported resources.",
"Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of compliant resources to the existing list of compliant resources. Effective org-policy of the Folder is considered to ensure there is no disruption to the existing customer workflows."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse": {
"description": "Response for restricting the list of allowed resources.",
"id": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse",
"properties": {},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1Violation": {
"description": "Workload monitoring Violation.",
"id": "GoogleCloudAssuredworkloadsV1beta1Violation",
"properties": {
"acknowledged": {
"description": "A boolean that indicates if the violation is acknowledged",
"type": "boolean"
},
"acknowledgementTime": {
"description": "Optional. Timestamp when this violation was acknowledged last. This will be absent when acknowledged field is marked as false.",
"format": "google-datetime",
"type": "string"
},
"auditLogLink": {
"description": "Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}",
"readOnly": true,
"type": "string"
},
"beginTime": {
"description": "Output only. Time of the event which triggered the Violation.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"category": {
"description": "Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.",
"readOnly": true,
"type": "string"
},
"exceptionAuditLogLink": {
"description": "Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization}",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}",
"readOnly": true,
"type": "string"
},
"nonCompliantOrgPolicy": {
"description": "Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}",
"readOnly": true,
"type": "string"
},
"orgPolicyConstraint": {
"description": "Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.",
"readOnly": true,
"type": "string"
},
"remediation": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediation",
"description": "Output only. Compliance violation remediation",
"readOnly": true
},
"resolveTime": {
"description": "Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. State of the violation",
"enum": [
"STATE_UNSPECIFIED",
"RESOLVED",
"UNRESOLVED",
"EXCEPTION"
],
"enumDescriptions": [
"Unspecified state.",
"Violation is resolved.",
"Violation is Unresolved",
"Violation is Exception"
],
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The last time when the Violation record was updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1ViolationRemediation": {
"description": "Represents remediation guidance to resolve compliance violation for AssuredWorkload",
"id": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediation",
"properties": {
"compliantValues": {
"description": "Values that can resolve the violation For example: for list org policy violations, this will either be the list of allowed or denied values",
"items": {
"type": "string"
},
"type": "array"
},
"instructions": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructions",
"description": "Required. Remediation instructions to resolve violations"
},
"remediationType": {
"description": "Output only. Reemediation type based on the type of org policy values violated",
"enum": [
"REMEDIATION_TYPE_UNSPECIFIED",
"REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION",
"REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION",
"REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION",
"REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION"
],
"enumDescriptions": [
"Unspecified remediation type",
"Remediation type for boolean org policy",
"Remediation type for list org policy which have allowed values in the monitoring rule",
"Remediation type for list org policy which have denied values in the monitoring rule",
"Remediation type for gcp.restrictCmekCryptoKeyProjects"
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructions": {
"description": "Instructions to remediate violation",
"id": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructions",
"properties": {
"consoleInstructions": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructionsConsole",
"description": "Remediation instructions to resolve violation via cloud console"
},
"gcloudInstructions": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructionsGcloud",
"description": "Remediation instructions to resolve violation via gcloud cli"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructionsConsole": {
"description": "Remediation instructions to resolve violation via cloud console",
"id": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructionsConsole",
"properties": {
"additionalLinks": {
"description": "Additional urls for more information about steps",
"items": {
"type": "string"
},
"type": "array"
},
"consoleUris": {
"description": "Link to console page where violations can be resolved",
"items": {
"type": "string"
},
"type": "array"
},
"steps": {
"description": "Steps to resolve violation via cloud console",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructionsGcloud": {
"description": "Remediation instructions to resolve violation via gcloud cli",
"id": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediationInstructionsGcloud",
"properties": {
"additionalLinks": {
"description": "Additional urls for more information about steps",
"items": {
"type": "string"
},
"type": "array"
},
"gcloudCommands": {
"description": "Gcloud command to resolve violation",
"items": {
"type": "string"
},
"type": "array"
},
"steps": {
"description": "Steps to resolve violation via gcloud cli",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1Workload": {
"description": "A Workload object for managing highly regulated workloads of cloud customers.",
"id": "GoogleCloudAssuredworkloadsV1beta1Workload",
"properties": {
"billingAccount": {
"description": "Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.",
"type": "string"
},
"cjisSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadCJISSettings",
"description": "Input only. Immutable. Settings specific to resources needed for CJIS."
},
"complianceRegime": {
"description": "Required. Immutable. Compliance Regime associated with this workload.",
"enum": [
"COMPLIANCE_REGIME_UNSPECIFIED",
"IL4",
"CJIS",
"FEDRAMP_HIGH",
"FEDRAMP_MODERATE",
"US_REGIONAL_ACCESS",
"HIPAA",
"HITRUST",
"EU_REGIONS_AND_SUPPORT",
"CA_REGIONS_AND_SUPPORT",
"ITAR",
"AU_REGIONS_AND_US_SUPPORT",
"ASSURED_WORKLOADS_FOR_PARTNERS",
"ISR_REGIONS"
],
"enumDescriptions": [
"Unknown compliance regime.",
"Information protection as per DoD IL4 requirements.",
"Criminal Justice Information Services (CJIS) Security policies.",
"FedRAMP High data protection controls",
"FedRAMP Moderate data protection controls",
"Assured Workloads For US Regions data protection controls",
"Health Insurance Portability and Accountability Act controls",
"Health Information Trust Alliance controls",
"Assured Workloads For EU Regions and Support controls",
"Assured Workloads For Canada Regions and Support controls",
"International Traffic in Arms Regulations",
"Assured Workloads for Australia Regions and Support controls Available for public preview consumption. Don't create production workloads.",
"Assured Workloads for Partners;",
"Assured Workloads for Israel"
],
"type": "string"
},
"complianceStatus": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceStatus",
"description": "Output only. Count of active Violations in the Workload.",
"readOnly": true
},
"compliantButDisallowedServices": {
"description": "Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.\"",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"createTime": {
"description": "Output only. Immutable. The Workload creation timestamp.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload",
"type": "string"
},
"enableSovereignControls": {
"description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.",
"type": "boolean"
},
"etag": {
"description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update \u0026 Delete operations.",
"type": "string"
},
"fedrampHighSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampHighSettings",
"description": "Input only. Immutable. Settings specific to resources needed for FedRAMP High."
},
"fedrampModerateSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampModerateSettings",
"description": "Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate."
},
"il4Settings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadIL4Settings",
"description": "Input only. Immutable. Settings specific to resources needed for IL4."
},
"kajEnrollmentState": {
"description": "Output only. Represents the KAJ enrollment state of the given workload.",
"enum": [
"KAJ_ENROLLMENT_STATE_UNSPECIFIED",
"KAJ_ENROLLMENT_STATE_PENDING",
"KAJ_ENROLLMENT_STATE_COMPLETE"
],
"enumDescriptions": [
"Default State for KAJ Enrollment.",
"Pending State for KAJ Enrollment.",