/
alertcenter-api.json
1922 lines (1922 loc) · 70.6 KB
/
alertcenter-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/apps.alerts": {
"description": "See and delete your domain's G Suite alerts, and send alert feedback"
}
}
}
},
"basePath": "",
"baseUrl": "https://alertcenter.googleapis.com/",
"batchPath": "batch",
"canonicalName": "AlertCenter",
"description": "Manages alerts on issues affecting your domain. Note: The current version of this API (v1beta1) is available to all Google Workspace customers. ",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/admin-sdk/alertcenter/",
"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": "alertcenter:v1beta1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://alertcenter.mtls.googleapis.com/",
"name": "alertcenter",
"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": {
"alerts": {
"methods": {
"batchDelete": {
"description": "Performs batch delete operation on alerts.",
"flatPath": "v1beta1/alerts:batchDelete",
"httpMethod": "POST",
"id": "alertcenter.alerts.batchDelete",
"parameterOrder": [],
"parameters": {},
"path": "v1beta1/alerts:batchDelete",
"request": {
"$ref": "BatchDeleteAlertsRequest"
},
"response": {
"$ref": "BatchDeleteAlertsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
]
},
"batchUndelete": {
"description": "Performs batch undelete operation on alerts.",
"flatPath": "v1beta1/alerts:batchUndelete",
"httpMethod": "POST",
"id": "alertcenter.alerts.batchUndelete",
"parameterOrder": [],
"parameters": {},
"path": "v1beta1/alerts:batchUndelete",
"request": {
"$ref": "BatchUndeleteAlertsRequest"
},
"response": {
"$ref": "BatchUndeleteAlertsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
]
},
"delete": {
"description": "Marks the specified alert for deletion. An alert that has been marked for deletion is removed from Alert Center after 30 days. Marking an alert for deletion has no effect on an alert which has already been marked for deletion. Attempting to mark a nonexistent alert for deletion results in a `NOT_FOUND` error.",
"flatPath": "v1beta1/alerts/{alertId}",
"httpMethod": "DELETE",
"id": "alertcenter.alerts.delete",
"parameterOrder": [
"alertId"
],
"parameters": {
"alertId": {
"description": "Required. The identifier of the alert to delete.",
"location": "path",
"required": true,
"type": "string"
},
"customerId": {
"description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/alerts/{alertId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
]
},
"get": {
"description": "Gets the specified alert. Attempting to get a nonexistent alert returns `NOT_FOUND` error.",
"flatPath": "v1beta1/alerts/{alertId}",
"httpMethod": "GET",
"id": "alertcenter.alerts.get",
"parameterOrder": [
"alertId"
],
"parameters": {
"alertId": {
"description": "Required. The identifier of the alert to retrieve.",
"location": "path",
"required": true,
"type": "string"
},
"customerId": {
"description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/alerts/{alertId}",
"response": {
"$ref": "Alert"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
]
},
"getMetadata": {
"description": "Returns the metadata of an alert. Attempting to get metadata for a non-existent alert returns `NOT_FOUND` error.",
"flatPath": "v1beta1/alerts/{alertId}/metadata",
"httpMethod": "GET",
"id": "alertcenter.alerts.getMetadata",
"parameterOrder": [
"alertId"
],
"parameters": {
"alertId": {
"description": "Required. The identifier of the alert this metadata belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"customerId": {
"description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert metadata is associated with. Inferred from the caller identity if not provided.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/alerts/{alertId}/metadata",
"response": {
"$ref": "AlertMetadata"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
]
},
"list": {
"description": "Lists the alerts.",
"flatPath": "v1beta1/alerts",
"httpMethod": "GET",
"id": "alertcenter.alerts.list",
"parameterOrder": [],
"parameters": {
"customerId": {
"description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided.",
"location": "query",
"type": "string"
},
"filter": {
"description": "Optional. A query string for filtering alert results. For more details, see [Query filters](https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/admin-sdk/alertcenter/reference/filter-fields#alerts.list).",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by=\"create_time desc\"`. Currently, supported sorting are `create_time asc`, `create_time desc`, `update_time desc`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/alerts",
"response": {
"$ref": "ListAlertsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
]
},
"undelete": {
"description": "Restores, or \"undeletes\", an alert that was marked for deletion within the past 30 days. Attempting to undelete an alert which was marked for deletion over 30 days ago (which has been removed from the Alert Center database) or a nonexistent alert returns a `NOT_FOUND` error. Attempting to undelete an alert which has not been marked for deletion has no effect.",
"flatPath": "v1beta1/alerts/{alertId}:undelete",
"httpMethod": "POST",
"id": "alertcenter.alerts.undelete",
"parameterOrder": [
"alertId"
],
"parameters": {
"alertId": {
"description": "Required. The identifier of the alert to undelete.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1beta1/alerts/{alertId}:undelete",
"request": {
"$ref": "UndeleteAlertRequest"
},
"response": {
"$ref": "Alert"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
]
}
},
"resources": {
"feedback": {
"methods": {
"create": {
"description": "Creates new feedback for an alert. Attempting to create a feedback for a non-existent alert returns `NOT_FOUND` error. Attempting to create a feedback for an alert that is marked for deletion returns `FAILED_PRECONDITION' error.",
"flatPath": "v1beta1/alerts/{alertId}/feedback",
"httpMethod": "POST",
"id": "alertcenter.alerts.feedback.create",
"parameterOrder": [
"alertId"
],
"parameters": {
"alertId": {
"description": "Required. The identifier of the alert this feedback belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"customerId": {
"description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/alerts/{alertId}/feedback",
"request": {
"$ref": "AlertFeedback"
},
"response": {
"$ref": "AlertFeedback"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
]
},
"list": {
"description": "Lists all the feedback for an alert. Attempting to list feedbacks for a non-existent alert returns `NOT_FOUND` error.",
"flatPath": "v1beta1/alerts/{alertId}/feedback",
"httpMethod": "GET",
"id": "alertcenter.alerts.feedback.list",
"parameterOrder": [
"alertId"
],
"parameters": {
"alertId": {
"description": "Required. The alert identifier. The \"-\" wildcard could be used to represent all alerts.",
"location": "path",
"required": true,
"type": "string"
},
"customerId": {
"description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert feedback are associated with. Inferred from the caller identity if not provided.",
"location": "query",
"type": "string"
},
"filter": {
"description": "Optional. A query string for filtering alert feedback results. For more details, see [Query filters](https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list).",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/alerts/{alertId}/feedback",
"response": {
"$ref": "ListAlertFeedbackResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
]
}
}
}
}
},
"v1beta1": {
"methods": {
"getSettings": {
"description": "Returns customer-level settings.",
"flatPath": "v1beta1/settings",
"httpMethod": "GET",
"id": "alertcenter.getSettings",
"parameterOrder": [],
"parameters": {
"customerId": {
"description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/settings",
"response": {
"$ref": "Settings"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
]
},
"updateSettings": {
"description": "Updates the customer-level settings.",
"flatPath": "v1beta1/settings",
"httpMethod": "PATCH",
"id": "alertcenter.updateSettings",
"parameterOrder": [],
"parameters": {
"customerId": {
"description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/settings",
"request": {
"$ref": "Settings"
},
"response": {
"$ref": "Settings"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
]
}
}
}
},
"revision": "20221010",
"rootUrl": "https://alertcenter.googleapis.com/",
"schemas": {
"AbuseDetected": {
"description": "A generic alert for abusive user activity occurring with a customer.",
"id": "AbuseDetected",
"properties": {
"additionalDetails": {
"$ref": "EntityList",
"description": "List of abusive users/entities to be displayed in a table in the alert."
},
"alertDescriptor": {
"description": "Displayed after Customer abuse detected - {alert_descriptor}. If missing, alert name will be displayed as Customer abuse detected.",
"type": "string"
},
"product": {
"description": "Product that the abuse is originating from.",
"type": "string"
},
"subAlertId": {
"description": "Unique identifier of each alert that is onboarded.",
"type": "string"
},
"summary": {
"description": "Customizable text to display in the summary section of the alert. Will be parsed as HTML to allow new paragraphs and hyperlinks.",
"type": "string"
}
},
"type": "object"
},
"AccountSuspensionDetails": {
"description": "Details about why an account is receiving an account suspension warning.",
"id": "AccountSuspensionDetails",
"properties": {
"abuseReason": {
"description": "The reason why this account is receiving an account suspension warning.",
"enum": [
"ACCOUNT_SUSPENSION_ABUSE_REASON_UNSPECIFIED",
"TOS_VIOLATION",
"SPAM",
"PHISHING",
"TRAFFIC_PUMPING",
"FRAUD",
"NUMBER_HARVESTING",
"PAYMENTS_FRAUD",
"UNWANTED_CONTENT"
],
"enumDescriptions": [
"Abuse reason is unspecified.",
"This account is being suspended for a Terms of Service violation.",
"This account is being suspended for spam.",
"This account is being suspended for phishing.",
"This account is being suspended for artificially boosting traffic to a website.",
"This account is being suspended for fraud.",
"This account is being suspended for number harvesting.",
"This account is being suspended for payments fraud.",
"This account is being suspended for unwanted content."
],
"type": "string"
},
"productName": {
"description": "The name of the product being abused. This is restricted to only the following values: \"Gmail\" \"Google Workspace\" \"Payments\" \"Voice\" \"YouTube\" \"Other\"",
"type": "string"
}
},
"type": "object"
},
"AccountSuspensionWarning": {
"description": "A warning that the customer's account is about to be suspended.",
"id": "AccountSuspensionWarning",
"properties": {
"appealWindow": {
"description": "The amount of time remaining to appeal an imminent suspension. After this window has elapsed, the account will be suspended. Only populated if the account suspension is in WARNING state.",
"format": "google-duration",
"type": "string"
},
"state": {
"description": "Account suspension warning state.",
"enum": [
"ACCOUNT_SUSPENSION_WARNING_STATE_UNSPECIFIED",
"WARNING",
"SUSPENDED",
"APPEAL_APPROVED",
"APPEAL_SUBMITTED"
],
"enumDescriptions": [
"State is unspecified.",
"Customer is receiving a warning about imminent suspension.",
"Customer is being notified that their account has been suspended.",
"Customer is being notified that their suspension appeal was approved.",
"Customer has submitted their appeal, which is pending review."
],
"type": "string"
},
"suspensionDetails": {
"description": "Details about why an account is being suspended.",
"items": {
"$ref": "AccountSuspensionDetails"
},
"type": "array"
}
},
"type": "object"
},
"AccountWarning": {
"description": "Alerts for user account warning events.",
"id": "AccountWarning",
"properties": {
"email": {
"description": "Required. The email of the user that this event belongs to.",
"type": "string"
},
"loginDetails": {
"$ref": "LoginDetails",
"description": "Optional. Details of the login action associated with the warning event. This is only available for: * Suspicious login * Suspicious login (less secure app) * Suspicious programmatic login * User suspended (suspicious activity)"
}
},
"type": "object"
},
"ActionInfo": {
"description": "Metadata related to the action.",
"id": "ActionInfo",
"properties": {},
"type": "object"
},
"ActivityRule": {
"description": "Alerts from Google Workspace Security Center rules service configured by an admin.",
"id": "ActivityRule",
"properties": {
"actionNames": {
"description": "List of action names associated with the rule threshold.",
"items": {
"type": "string"
},
"type": "array"
},
"createTime": {
"description": "Rule create timestamp.",
"format": "google-datetime",
"type": "string"
},
"description": {
"description": "Description of the rule.",
"type": "string"
},
"displayName": {
"description": "Alert display name.",
"type": "string"
},
"name": {
"description": "Rule name.",
"type": "string"
},
"query": {
"description": "Query that is used to get the data from the associated source.",
"type": "string"
},
"supersededAlerts": {
"description": "List of alert IDs superseded by this alert. It is used to indicate that this alert is essentially extension of superseded alerts and we found the relationship after creating these alerts.",
"items": {
"type": "string"
},
"type": "array"
},
"supersedingAlert": {
"description": "Alert ID superseding this alert. It is used to indicate that superseding alert is essentially extension of this alert and we found the relationship after creating both alerts.",
"type": "string"
},
"threshold": {
"description": "Alert threshold is for example “COUNT \u003e 5”.",
"type": "string"
},
"triggerSource": {
"description": "The trigger sources for this rule. * GMAIL_EVENTS * DEVICE_EVENTS * USER_EVENTS",
"type": "string"
},
"updateTime": {
"description": "The timestamp of the last update to the rule.",
"format": "google-datetime",
"type": "string"
},
"windowSize": {
"description": "Rule window size. Possible values are 1 hour or 24 hours.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"Alert": {
"description": "An alert affecting a customer.",
"id": "Alert",
"properties": {
"alertId": {
"description": "Output only. The unique identifier for the alert.",
"type": "string"
},
"createTime": {
"description": "Output only. The time this alert was created.",
"format": "google-datetime",
"type": "string"
},
"customerId": {
"description": "Output only. The unique identifier of the Google account of the customer.",
"type": "string"
},
"data": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.",
"type": "object"
},
"deleted": {
"description": "Output only. `True` if this alert is marked for deletion.",
"type": "boolean"
},
"endTime": {
"description": "Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, it indicates an ongoing alert.",
"format": "google-datetime",
"type": "string"
},
"etag": {
"description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform alert updates in order to avoid race conditions: An `etag` is returned in the response which contains alerts, and systems are expected to put that etag in the request to update alert to ensure that their change will be applied to the same version of the alert. If no `etag` is provided in the call to update alert, then the existing alert is overwritten blindly.",
"type": "string"
},
"metadata": {
"$ref": "AlertMetadata",
"description": "Output only. The metadata associated with this alert."
},
"securityInvestigationToolLink": {
"description": "Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.",
"type": "string"
},
"source": {
"description": "Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Data Loss Prevention * Domain wide takeout * State sponsored attack * Google identity * Apps outage",
"type": "string"
},
"startTime": {
"description": "Required. The time the event that caused this alert was started or detected.",
"format": "google-datetime",
"type": "string"
},
"type": {
"description": "Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](https://developers.google.com/admin-sdk/alertcenter/reference/alert-types).",
"type": "string"
},
"updateTime": {
"description": "Output only. The time this alert was last updated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"AlertFeedback": {
"description": "A customer feedback about an alert.",
"id": "AlertFeedback",
"properties": {
"alertId": {
"description": "Output only. The alert identifier.",
"type": "string"
},
"createTime": {
"description": "Output only. The time this feedback was created.",
"format": "google-datetime",
"type": "string"
},
"customerId": {
"description": "Output only. The unique identifier of the Google account of the customer.",
"type": "string"
},
"email": {
"description": "Output only. The email of the user that provided the feedback.",
"type": "string"
},
"feedbackId": {
"description": "Output only. The unique identifier for the feedback.",
"type": "string"
},
"type": {
"description": "Required. The type of the feedback.",
"enum": [
"ALERT_FEEDBACK_TYPE_UNSPECIFIED",
"NOT_USEFUL",
"SOMEWHAT_USEFUL",
"VERY_USEFUL"
],
"enumDescriptions": [
"The feedback type is not specified.",
"The alert report is not useful.",
"The alert report is somewhat useful.",
"The alert report is very useful."
],
"type": "string"
}
},
"type": "object"
},
"AlertMetadata": {
"description": "An alert metadata.",
"id": "AlertMetadata",
"properties": {
"alertId": {
"description": "Output only. The alert identifier.",
"type": "string"
},
"assignee": {
"description": "The email address of the user assigned to the alert.",
"type": "string"
},
"customerId": {
"description": "Output only. The unique identifier of the Google account of the customer.",
"type": "string"
},
"etag": {
"description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metadata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly.",
"type": "string"
},
"severity": {
"description": "The severity value of the alert. Alert Center will set this field at alert creation time, default's to an empty string when it could not be determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW",
"type": "string"
},
"status": {
"description": "The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED",
"type": "string"
},
"updateTime": {
"description": "Output only. The time this metadata was last updated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"ApnsCertificateExpirationInfo": {
"description": "The explanation message associated with ApnsCertificationExpiring and ApnsCertificationExpired alerts.",
"id": "ApnsCertificateExpirationInfo",
"properties": {
"appleId": {
"description": "The Apple ID used for the certificate, may be blank if admins did not enter it.",
"type": "string"
},
"expirationTime": {
"description": "The expiration date of the APNS Certificate.",
"format": "google-datetime",
"type": "string"
},
"uid": {
"description": "The UID for the certificate.",
"type": "string"
}
},
"type": "object"
},
"AppMakerSqlSetupNotification": {
"description": "Alerts from App Maker to notify admins to set up default SQL instance.",
"id": "AppMakerSqlSetupNotification",
"properties": {
"requestInfo": {
"description": "List of applications with requests for default SQL set up.",
"items": {
"$ref": "RequestInfo"
},
"type": "array"
}
},
"type": "object"
},
"AppSettingsChanged": {
"description": "Alerts from AppSettingsChanged bucket Rules configured by Admin which contain the below rules. Calendar settings changed Drive settings changed Email settings changed Mobile settings changed",
"id": "AppSettingsChanged",
"properties": {
"alertDetails": {
"description": "Any other associated alert details, for example, AlertConfiguration.",
"format": "byte",
"type": "string"
},
"name": {
"description": "Rule name",
"type": "string"
}
},
"type": "object"
},
"AppsOutage": {
"description": "An outage incident reported for a Google Workspace service.",
"id": "AppsOutage",
"properties": {
"dashboardUri": {
"description": "Link to the outage event in Google Workspace Status Dashboard",
"type": "string"
},
"incidentTrackingId": {
"description": "Incident tracking ID.",
"type": "string"
},
"mergeInfo": {
"$ref": "MergeInfo",
"description": "Indicates new alert details under which the outage is communicated. Only populated when Status is MERGED."
},
"nextUpdateTime": {
"description": "Timestamp by which the next update is expected to arrive.",
"format": "google-datetime",
"type": "string"
},
"products": {
"description": "List of products impacted by the outage.",
"items": {
"type": "string"
},
"type": "array"
},
"resolutionTime": {
"description": "Timestamp when the outage is expected to be resolved, or has confirmed resolution. Provided only when known.",
"format": "google-datetime",
"type": "string"
},
"status": {
"description": "Current outage status.",
"enum": [
"STATUS_UNSPECIFIED",
"NEW",
"ONGOING",
"RESOLVED",
"FALSE_POSITIVE",
"PARTIALLY_RESOLVED",
"MERGED",
"DOWNGRADED"
],
"enumDescriptions": [
"Status is unspecified.",
"The incident has just been reported.",
"The incident is ongoing.",
"The incident has been resolved.",
"Further assessment indicated no customer impact.",
"The incident has been partially resolved.",
"The incident was merged into a parent.",
"The incident has lower impact than initially anticipated."
],
"type": "string"
}
},
"type": "object"
},
"Attachment": {
"description": "Attachment with application-specific information about an alert.",
"id": "Attachment",
"properties": {
"csv": {
"$ref": "Csv",
"description": "A CSV file attachment."
}
},
"type": "object"
},
"BadWhitelist": {
"description": "Alert for setting the domain or IP that malicious email comes from as whitelisted domain or IP in Gmail advanced settings.",
"id": "BadWhitelist",
"properties": {
"domainId": {
"$ref": "DomainId",
"description": "The domain ID."
},
"maliciousEntity": {
"$ref": "MaliciousEntity",
"description": "The entity whose actions triggered a Gmail phishing alert."
},
"messages": {
"description": "The list of messages contained by this alert.",
"items": {
"$ref": "GmailMessageInfo"
},
"type": "array"
},
"sourceIp": {
"description": "The source IP address of the malicious email, for example, `127.0.0.1`.",
"type": "string"
}
},
"type": "object"
},
"BatchDeleteAlertsRequest": {
"description": "A request to perform batch delete on alerts.",
"id": "BatchDeleteAlertsRequest",
"properties": {
"alertId": {
"description": "Required. list of alert IDs.",
"items": {
"type": "string"
},
"type": "array"
},
"customerId": {
"description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.",
"type": "string"
}
},
"type": "object"
},
"BatchDeleteAlertsResponse": {
"description": "Response to batch delete operation on alerts.",
"id": "BatchDeleteAlertsResponse",
"properties": {
"failedAlertStatus": {
"additionalProperties": {
"$ref": "Status"
},
"description": "The status details for each failed alert_id.",
"type": "object"
},
"successAlertIds": {
"description": "The successful list of alert IDs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BatchUndeleteAlertsRequest": {
"description": "A request to perform batch undelete on alerts.",
"id": "BatchUndeleteAlertsRequest",
"properties": {
"alertId": {
"description": "Required. list of alert IDs.",
"items": {
"type": "string"
},
"type": "array"
},
"customerId": {
"description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.",
"type": "string"
}
},
"type": "object"
},
"BatchUndeleteAlertsResponse": {
"description": "Response to batch undelete operation on alerts.",
"id": "BatchUndeleteAlertsResponse",
"properties": {
"failedAlertStatus": {
"additionalProperties": {
"$ref": "Status"
},
"description": "The status details for each failed alert_id.",
"type": "object"
},
"successAlertIds": {
"description": "The successful list of alert IDs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CloudPubsubTopic": {
"description": "A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.",
"id": "CloudPubsubTopic",
"properties": {
"payloadFormat": {
"description": "Optional. The format of the payload that would be sent. If not specified the format will be JSON.",
"enum": [
"PAYLOAD_FORMAT_UNSPECIFIED",
"JSON"
],
"enumDescriptions": [
"Payload format is not specified (will use JSON as default).",
"Use JSON."
],