/
securitycenter.v1.json
6394 lines (6394 loc) 路 327 KB
/
securitycenter.v1.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://securitycenter.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Security Command Center",
"description": "Security Command Center API provides access to temporal views of assets and findings within an organization.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/security-command-center",
"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": "securitycenter:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://securitycenter.mtls.googleapis.com/",
"name": "securitycenter",
"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": {
"resources": {
"assets": {
"methods": {
"group": {
"description": "Filters an organization's assets and groups them by their specified properties.",
"flatPath": "v1/folders/{foldersId}/assets:group",
"httpMethod": "POST",
"id": "securitycenter.folders.assets.group",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the organization to groupBy. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/assets:group",
"request": {
"$ref": "GroupAssetsRequest"
},
"response": {
"$ref": "GroupAssetsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists an organization's assets.",
"flatPath": "v1/folders/{foldersId}/assets",
"httpMethod": "GET",
"id": "securitycenter.folders.assets.list",
"parameterOrder": [
"parent"
],
"parameters": {
"compareDuration": {
"description": "When compare_duration is set, the ListAssetsResult's \"state_change\" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state_change\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present at the start of compare_duration, but present at read_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at read_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all assets present at read_time.",
"format": "google-duration",
"location": "query",
"type": "string"
},
"fieldMask": {
"description": "A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"filter": {
"description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = \"2019-06-10T16:07:18-07:00\"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = \"2019-06-10T16:07:18-07:00\"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : \"\"`",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,resource_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,resource_properties.a_property\" and \" name desc , resource_properties.a_property \" are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Name of the organization assets should belong to. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
},
"readTime": {
"description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.",
"format": "google-datetime",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/assets",
"response": {
"$ref": "ListAssetsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateSecurityMarks": {
"description": "Updates security marks.",
"flatPath": "v1/folders/{foldersId}/assets/{assetsId}/securityMarks",
"httpMethod": "PATCH",
"id": "securitycenter.folders.assets.updateSecurityMarks",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".",
"location": "path",
"pattern": "^folders/[^/]+/assets/[^/]+/securityMarks$",
"required": true,
"type": "string"
},
"startTime": {
"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.",
"format": "google-datetime",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to \"marks\", all marks will be replaced. Individual marks can be updated using \"marks.\".",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "SecurityMarks"
},
"response": {
"$ref": "SecurityMarks"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"bigQueryExports": {
"methods": {
"create": {
"description": "Creates a big query export.",
"flatPath": "v1/folders/{foldersId}/bigQueryExports",
"httpMethod": "POST",
"id": "securitycenter.folders.bigQueryExports.create",
"parameterOrder": [
"parent"
],
"parameters": {
"bigQueryExportId": {
"description": "Required. Unique identifier provided by the client within the parent scope. It must consist of lower case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the new big query export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/bigQueryExports",
"request": {
"$ref": "GoogleCloudSecuritycenterV1BigQueryExport"
},
"response": {
"$ref": "GoogleCloudSecuritycenterV1BigQueryExport"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an existing big query export.",
"flatPath": "v1/folders/{foldersId}/bigQueryExports/{bigQueryExportsId}",
"httpMethod": "DELETE",
"id": "securitycenter.folders.bigQueryExports.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the big query export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}",
"location": "path",
"pattern": "^folders/[^/]+/bigQueryExports/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a big query export.",
"flatPath": "v1/folders/{foldersId}/bigQueryExports/{bigQueryExportsId}",
"httpMethod": "GET",
"id": "securitycenter.folders.bigQueryExports.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the big query export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}",
"location": "path",
"pattern": "^folders/[^/]+/bigQueryExports/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudSecuritycenterV1BigQueryExport"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.",
"flatPath": "v1/folders/{foldersId}/bigQueryExports",
"httpMethod": "GET",
"id": "securitycenter.folders.bigQueryExports.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListBigQueryExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryExports` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent, which owns the collection of BigQuery exports. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/bigQueryExports",
"response": {
"$ref": "ListBigQueryExportsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a BigQuery export.",
"flatPath": "v1/folders/{foldersId}/bigQueryExports/{bigQueryExportsId}",
"httpMethod": "PATCH",
"id": "securitycenter.folders.bigQueryExports.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: \"organizations/{organization_id}/bigQueryExports/{export_id}\" Example format: \"folders/{folder_id}/bigQueryExports/{export_id}\" Example format: \"projects/{project_id}/bigQueryExports/{export_id}\" This field is provided in responses, and is ignored when provided in create requests.",
"location": "path",
"pattern": "^folders/[^/]+/bigQueryExports/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The list of fields to be updated. If empty all mutable fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudSecuritycenterV1BigQueryExport"
},
"response": {
"$ref": "GoogleCloudSecuritycenterV1BigQueryExport"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"findings": {
"methods": {
"bulkMute": {
"description": "Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.",
"flatPath": "v1/folders/{foldersId}/findings:bulkMute",
"httpMethod": "POST",
"id": "securitycenter.folders.findings.bulkMute",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent, at which bulk action needs to be applied. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/findings:bulkMute",
"request": {
"$ref": "BulkMuteFindingsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"muteConfigs": {
"methods": {
"create": {
"description": "Creates a mute config.",
"flatPath": "v1/folders/{foldersId}/muteConfigs",
"httpMethod": "POST",
"id": "securitycenter.folders.muteConfigs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"muteConfigId": {
"description": "Required. Unique identifier provided by the client within the parent scope. It must consist of lower case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/muteConfigs",
"request": {
"$ref": "GoogleCloudSecuritycenterV1MuteConfig"
},
"response": {
"$ref": "GoogleCloudSecuritycenterV1MuteConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an existing mute config.",
"flatPath": "v1/folders/{foldersId}/muteConfigs/{muteConfigsId}",
"httpMethod": "DELETE",
"id": "securitycenter.folders.muteConfigs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, or projects/{project}/muteConfigs/{config_id}",
"location": "path",
"pattern": "^folders/[^/]+/muteConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a mute config.",
"flatPath": "v1/folders/{foldersId}/muteConfigs/{muteConfigsId}",
"httpMethod": "GET",
"id": "securitycenter.folders.muteConfigs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, or projects/{project}/muteConfigs/{config_id}",
"location": "path",
"pattern": "^folders/[^/]+/muteConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudSecuritycenterV1MuteConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists mute configs.",
"flatPath": "v1/folders/{foldersId}/muteConfigs",
"httpMethod": "GET",
"id": "securitycenter.folders.muteConfigs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/muteConfigs",
"response": {
"$ref": "ListMuteConfigsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a mute config.",
"flatPath": "v1/folders/{foldersId}/muteConfigs/{muteConfigsId}",
"httpMethod": "PATCH",
"id": "securitycenter.folders.muteConfigs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\"",
"location": "path",
"pattern": "^folders/[^/]+/muteConfigs/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The list of fields to be updated. If empty all mutable fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudSecuritycenterV1MuteConfig"
},
"response": {
"$ref": "GoogleCloudSecuritycenterV1MuteConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"notificationConfigs": {
"methods": {
"create": {
"description": "Creates a notification config.",
"flatPath": "v1/folders/{foldersId}/notificationConfigs",
"httpMethod": "POST",
"id": "securitycenter.folders.notificationConfigs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"configId": {
"description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contains alphanumeric characters, underscores or hyphens only.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the new notification config's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/notificationConfigs",
"request": {
"$ref": "NotificationConfig"
},
"response": {
"$ref": "NotificationConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a notification config.",
"flatPath": "v1/folders/{foldersId}/notificationConfigs/{notificationConfigsId}",
"httpMethod": "DELETE",
"id": "securitycenter.folders.notificationConfigs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the notification config to delete. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\".",
"location": "path",
"pattern": "^folders/[^/]+/notificationConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a notification config.",
"flatPath": "v1/folders/{foldersId}/notificationConfigs/{notificationConfigsId}",
"httpMethod": "GET",
"id": "securitycenter.folders.notificationConfigs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the notification config to get. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\".",
"location": "path",
"pattern": "^folders/[^/]+/notificationConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "NotificationConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists notification configs.",
"flatPath": "v1/folders/{foldersId}/notificationConfigs",
"httpMethod": "GET",
"id": "securitycenter.folders.notificationConfigs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListNotificationConfigsResponse`; indicates that this is a continuation of a prior `ListNotificationConfigs` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Name of the organization to list notification configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/notificationConfigs",
"response": {
"$ref": "ListNotificationConfigsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": " Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter",
"flatPath": "v1/folders/{foldersId}/notificationConfigs/{notificationConfigsId}",
"httpMethod": "PATCH",
"id": "securitycenter.folders.notificationConfigs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/notificationConfigs/notify_public_bucket\".",
"location": "path",
"pattern": "^folders/[^/]+/notificationConfigs/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The FieldMask to use when updating the notification config. If empty all mutable fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "NotificationConfig"
},
"response": {
"$ref": "NotificationConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"sources": {
"methods": {
"list": {
"description": "Lists all sources belonging to an organization.",
"flatPath": "v1/folders/{foldersId}/sources",
"httpMethod": "GET",
"id": "securitycenter.folders.sources.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/sources",
"response": {
"$ref": "ListSourcesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"findings": {
"methods": {
"group": {
"description": "Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings",
"flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings:group",
"httpMethod": "POST",
"id": "securitycenter.folders.sources.findings.group",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the source to groupBy. Its format is \"organizations/[organization_id]/sources/[source_id]\", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-",
"location": "path",
"pattern": "^folders/[^/]+/sources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/findings:group",
"request": {
"$ref": "GroupFindingsRequest"
},
"response": {
"$ref": "GroupFindingsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings",
"flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings",
"httpMethod": "GET",
"id": "securitycenter.folders.sources.findings.list",
"parameterOrder": [
"parent"
],
"parameters": {
"compareDuration": {
"description": "When compare_duration is set, the ListFindingsResult's \"state_change\" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible \"state_change\" values when compare_duration is specified: * \"CHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * \"UNCHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * \"ADDED\": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * \"REMOVED\": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all findings present at read_time.",
"format": "google-duration",
"location": "query",
"type": "string"
},
"fieldMask": {
"description": "A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"filter": {
"description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"` * resource: * resource.name: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.type: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.display_name: `=`, `:`",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,source_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,source_properties.a_property\" and \" name desc , source_properties.a_property \" are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Name of the source the findings belong to. Its format is \"organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]\". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or projects/{projects_id}/sources/-",
"location": "path",
"pattern": "^folders/[^/]+/sources/[^/]+$",
"required": true,
"type": "string"
},
"readTime": {
"description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.",
"format": "google-datetime",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/findings",
"response": {
"$ref": "ListFindingsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.",
"flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}",
"httpMethod": "PATCH",
"id": "securitycenter.folders.sources.findings.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\"",
"location": "path",
"pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using \"source_properties.\" in the field mask.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Finding"
},
"response": {
"$ref": "Finding"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setMute": {
"description": "Updates the mute state of a finding.",
"flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}:setMute",
"httpMethod": "POST",
"id": "securitycenter.folders.sources.findings.setMute",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".",
"location": "path",
"pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:setMute",
"request": {
"$ref": "SetMuteRequest"
},
"response": {
"$ref": "Finding"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setState": {
"description": "Updates the state of a finding.",
"flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}:setState",
"httpMethod": "POST",
"id": "securitycenter.folders.sources.findings.setState",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\".",
"location": "path",
"pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:setState",
"request": {
"$ref": "SetFindingStateRequest"
},
"response": {
"$ref": "Finding"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateSecurityMarks": {
"description": "Updates security marks.",
"flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}/securityMarks",
"httpMethod": "PATCH",
"id": "securitycenter.folders.sources.findings.updateSecurityMarks",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".",
"location": "path",
"pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+/securityMarks$",
"required": true,
"type": "string"
},
"startTime": {
"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.",
"format": "google-datetime",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to \"marks\", all marks will be replaced. Individual marks can be updated using \"marks.\".",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}