1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="alertcenter_v1beta1.html">G Suite Alert Center API</a> . <a href="alertcenter_v1beta1.alerts.html">alerts</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="alertcenter_v1beta1.alerts.feedback.html">feedback()</a></code> 79</p> 80<p class="firstline">Returns the feedback Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#delete">delete(alertId, customerId=None, x__xgafv=None)</a></code></p> 84<p class="firstline">Marks the specified alert for deletion. An alert that has been marked for</p> 85<p class="toc_element"> 86 <code><a href="#get">get(alertId, customerId=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Gets the specified alert. Attempting to get a nonexistent alert returns</p> 88<p class="toc_element"> 89 <code><a href="#list">list(orderBy=None, pageSize=None, pageToken=None, customerId=None, x__xgafv=None, filter=None)</a></code></p> 90<p class="firstline">Lists the alerts.</p> 91<p class="toc_element"> 92 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 93<p class="firstline">Retrieves the next page of results.</p> 94<p class="toc_element"> 95 <code><a href="#undelete">undelete(alertId, body, x__xgafv=None)</a></code></p> 96<p class="firstline">Restores, or "undeletes", an alert that was marked for deletion within the</p> 97<h3>Method Details</h3> 98<div class="method"> 99 <code class="details" id="delete">delete(alertId, customerId=None, x__xgafv=None)</code> 100 <pre>Marks the specified alert for deletion. An alert that has been marked for 101deletion is removed from Alert Center after 30 days. 102Marking an alert for deletion has no effect on an alert which has 103already been marked for deletion. Attempting to mark a nonexistent alert 104for deletion results in a `NOT_FOUND` error. 105 106Args: 107 alertId: string, Required. The identifier of the alert to delete. (required) 108 customerId: string, Optional. The unique identifier of the G Suite organization account of the 109customer the alert is associated with. 110Inferred from the caller identity if not provided. 111 x__xgafv: string, V1 error format. 112 Allowed values 113 1 - v1 error format 114 2 - v2 error format 115 116Returns: 117 An object of the form: 118 119 { # A generic empty message that you can re-use to avoid defining duplicated 120 # empty messages in your APIs. A typical example is to use it as the request 121 # or the response type of an API method. For instance: 122 # 123 # service Foo { 124 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 125 # } 126 # 127 # The JSON representation for `Empty` is empty JSON object `{}`. 128 }</pre> 129</div> 130 131<div class="method"> 132 <code class="details" id="get">get(alertId, customerId=None, x__xgafv=None)</code> 133 <pre>Gets the specified alert. Attempting to get a nonexistent alert returns 134`NOT_FOUND` error. 135 136Args: 137 alertId: string, Required. The identifier of the alert to retrieve. (required) 138 customerId: string, Optional. The unique identifier of the G Suite organization account of the 139customer the alert is associated with. 140Inferred from the caller identity if not provided. 141 x__xgafv: string, V1 error format. 142 Allowed values 143 1 - v1 error format 144 2 - v2 error format 145 146Returns: 147 An object of the form: 148 149 { # An alert affecting a customer. 150 "updateTime": "A String", # Output only. The time this alert was last updated. 151 "alertId": "A String", # Output only. The unique identifier for the alert. 152 "deleted": True or False, # Output only. `True` if this alert is marked for deletion. 153 "type": "A String", # Required. The type of the alert. 154 # This is output only after alert is created. 155 # For a list of available alert types see 156 # [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types). 157 "createTime": "A String", # Output only. The time this alert was created. 158 "source": "A String", # Required. A unique identifier for the system that reported the alert. 159 # This is output only after alert is created. 160 # 161 # Supported sources are any of the following: 162 # 163 # * Google Operations 164 # * Mobile device management 165 # * Gmail phishing 166 # * Domain wide takeout 167 # * Government attack warning 168 # * Google identity 169 "startTime": "A String", # Required. The time the event that caused this alert was started or 170 # detected. 171 "endTime": "A String", # Optional. The time the event that caused this alert ceased being active. 172 # If provided, the end time must not be earlier than the start time. 173 # If not provided, it indicates an ongoing alert. 174 "data": { # Optional. The data associated with this alert, for example 175 # google.apps.alertcenter.type.DeviceCompromised. 176 "a_key": "", # Properties of the object. Contains field @type with type URL. 177 }, 178 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer. 179 "securityInvestigationToolLink": "A String", # Output only. An optional 180 # [Security Investigation Tool](https://support.google.com/a/answer/7575955) 181 # query for this alert. 182 }</pre> 183</div> 184 185<div class="method"> 186 <code class="details" id="list">list(orderBy=None, pageSize=None, pageToken=None, customerId=None, x__xgafv=None, filter=None)</code> 187 <pre>Lists the alerts. 188 189Args: 190 orderBy: string, Optional. The sort order of the list results. 191If not specified results may be returned in arbitrary order. 192You can sort the results in descending order based on the creation 193timestamp using `order_by="create_time desc"`. 194Currently, supported sorting are `create_time asc`, `create_time desc`, 195`update_time desc` 196 pageSize: integer, Optional. The requested page size. Server may return fewer items than 197requested. If unspecified, server picks an appropriate default. 198 pageToken: string, Optional. A token identifying a page of results the server should return. 199If empty, a new iteration is started. To continue an iteration, pass in 200the value from the previous ListAlertsResponse's 201next_page_token field. 202 customerId: string, Optional. The unique identifier of the G Suite organization account of the 203customer the alerts are associated with. 204Inferred from the caller identity if not provided. 205 x__xgafv: string, V1 error format. 206 Allowed values 207 1 - v1 error format 208 2 - v2 error format 209 filter: string, Optional. A query string for filtering alert results. 210For more details, see [Query 211filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported 212query filter 213fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list). 214 215Returns: 216 An object of the form: 217 218 { # Response message for an alert listing request. 219 "nextPageToken": "A String", # The token for the next page. If not empty, indicates that there may be more 220 # alerts that match the listing request; this value can be used in a 221 # subsequent ListAlertsRequest to get alerts continuing from last result 222 # of the current list call. 223 "alerts": [ # The list of alerts. 224 { # An alert affecting a customer. 225 "updateTime": "A String", # Output only. The time this alert was last updated. 226 "alertId": "A String", # Output only. The unique identifier for the alert. 227 "deleted": True or False, # Output only. `True` if this alert is marked for deletion. 228 "type": "A String", # Required. The type of the alert. 229 # This is output only after alert is created. 230 # For a list of available alert types see 231 # [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types). 232 "createTime": "A String", # Output only. The time this alert was created. 233 "source": "A String", # Required. A unique identifier for the system that reported the alert. 234 # This is output only after alert is created. 235 # 236 # Supported sources are any of the following: 237 # 238 # * Google Operations 239 # * Mobile device management 240 # * Gmail phishing 241 # * Domain wide takeout 242 # * Government attack warning 243 # * Google identity 244 "startTime": "A String", # Required. The time the event that caused this alert was started or 245 # detected. 246 "endTime": "A String", # Optional. The time the event that caused this alert ceased being active. 247 # If provided, the end time must not be earlier than the start time. 248 # If not provided, it indicates an ongoing alert. 249 "data": { # Optional. The data associated with this alert, for example 250 # google.apps.alertcenter.type.DeviceCompromised. 251 "a_key": "", # Properties of the object. Contains field @type with type URL. 252 }, 253 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer. 254 "securityInvestigationToolLink": "A String", # Output only. An optional 255 # [Security Investigation Tool](https://support.google.com/a/answer/7575955) 256 # query for this alert. 257 }, 258 ], 259 }</pre> 260</div> 261 262<div class="method"> 263 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 264 <pre>Retrieves the next page of results. 265 266Args: 267 previous_request: The request for the previous page. (required) 268 previous_response: The response from the request for the previous page. (required) 269 270Returns: 271 A request object that you can call 'execute()' on to request the next 272 page. Returns None if there are no more items in the collection. 273 </pre> 274</div> 275 276<div class="method"> 277 <code class="details" id="undelete">undelete(alertId, body, x__xgafv=None)</code> 278 <pre>Restores, or "undeletes", an alert that was marked for deletion within the 279past 30 days. Attempting to undelete an alert which was marked for deletion 280over 30 days ago (which has been removed from the Alert Center database) or 281a nonexistent alert returns a `NOT_FOUND` error. Attempting to 282undelete an alert which has not been marked for deletion has no effect. 283 284Args: 285 alertId: string, Required. The identifier of the alert to undelete. (required) 286 body: object, The request body. (required) 287 The object takes the form of: 288 289{ # A request to undelete a specific alert that was marked for deletion. 290 "customerId": "A String", # Optional. The unique identifier of the G Suite organization account of the 291 # customer the alert is associated with. 292 # Inferred from the caller identity if not provided. 293 } 294 295 x__xgafv: string, V1 error format. 296 Allowed values 297 1 - v1 error format 298 2 - v2 error format 299 300Returns: 301 An object of the form: 302 303 { # An alert affecting a customer. 304 "updateTime": "A String", # Output only. The time this alert was last updated. 305 "alertId": "A String", # Output only. The unique identifier for the alert. 306 "deleted": True or False, # Output only. `True` if this alert is marked for deletion. 307 "type": "A String", # Required. The type of the alert. 308 # This is output only after alert is created. 309 # For a list of available alert types see 310 # [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types). 311 "createTime": "A String", # Output only. The time this alert was created. 312 "source": "A String", # Required. A unique identifier for the system that reported the alert. 313 # This is output only after alert is created. 314 # 315 # Supported sources are any of the following: 316 # 317 # * Google Operations 318 # * Mobile device management 319 # * Gmail phishing 320 # * Domain wide takeout 321 # * Government attack warning 322 # * Google identity 323 "startTime": "A String", # Required. The time the event that caused this alert was started or 324 # detected. 325 "endTime": "A String", # Optional. The time the event that caused this alert ceased being active. 326 # If provided, the end time must not be earlier than the start time. 327 # If not provided, it indicates an ongoing alert. 328 "data": { # Optional. The data associated with this alert, for example 329 # google.apps.alertcenter.type.DeviceCompromised. 330 "a_key": "", # Properties of the object. Contains field @type with type URL. 331 }, 332 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer. 333 "securityInvestigationToolLink": "A String", # Output only. An optional 334 # [Security Investigation Tool](https://support.google.com/a/answer/7575955) 335 # query for this alert. 336 }</pre> 337</div> 338 339</body></html>