Blame - docs/dyn/alertcenter_v1beta1.alerts.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

<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

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

83

<code><a href="#batchDelete">batchDelete(body=None, x__xgafv=None)</a></code></p>

84

<p class="firstline">Performs batch delete operation on alerts.</p>

85

86

<code><a href="#batchUndelete">batchUndelete(body=None, x__xgafv=None)</a></code></p>

87

<p class="firstline">Performs batch undelete operation on alerts.</p>

88

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

89

<code><a href="#delete">delete(alertId, customerId=None, x__xgafv=None)</a></code></p>

90

<p class="firstline">Marks the specified alert for deletion. An alert that has been marked for</p>

91

92

<code><a href="#get">get(alertId, customerId=None, x__xgafv=None)</a></code></p>

93

<p class="firstline">Gets the specified alert. Attempting to get a nonexistent alert returns</p>

94

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

95

<code><a href="#getMetadata">getMetadata(alertId, customerId=None, x__xgafv=None)</a></code></p>

96

<p class="firstline">Returns the metadata of an alert. Attempting to get metadata for</p>

97

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

98

<code><a href="#list">list(pageSize=None, pageToken=None, orderBy=None, customerId=None, filter=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

99

<p class="firstline">Lists the alerts.</p>

100

101

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

102

<p class="firstline">Retrieves the next page of results.</p>

103

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

104

<code><a href="#undelete">undelete(alertId, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

105

<p class="firstline">Restores, or "undeletes", an alert that was marked for deletion within the</p>

106

<h3>Method Details</h3>

107

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

108

<code class="details" id="batchDelete">batchDelete(body=None, x__xgafv=None)</code>

109

<pre>Performs batch delete operation on alerts.

110

111

Args:

112

body: object, The request body.

113

The object takes the form of:

114

115

{ # A request to perform batch delete on alerts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

116

"alertId": [ # Required. list of alert IDs.

117

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

118

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

119

"customerId": "A String", # Optional. The unique identifier of the G Suite organization account of the

120

# customer the alerts are associated with.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

121

}

122

123

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

130

131

{ # Response to batch delete operation on alerts.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

132

"successAlertIds": [ # The successful list of alert IDs.

133

"A String",

134

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

135

"failedAlertStatus": { # The status details for each failed alert_id.

136

"a_key": { # The `Status` type defines a logical error model that is suitable for

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

137

# different programming environments, including REST APIs and RPC APIs. It is

138

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

139

# three pieces of data: error code, error message, and error details.

140

#

141

# You can find out more about this error model and how to work with it in the

142

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

143

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

144

"details": [ # A list of messages that carry the error details. There is a common set of

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

145

# message types for APIs to use.

146

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

147

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

148

},

149

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

150

"message": "A String", # A developer-facing error message, which should be in English. Any

151

# user-facing error message should be localized and sent in the

152

# google.rpc.Status.details field, or localized by the client.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

153

},

154

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="batchUndelete">batchUndelete(body=None, x__xgafv=None)</code>

160

<pre>Performs batch undelete operation on alerts.

161

162

Args:

163

body: object, The request body.

164

The object takes the form of:

165

166

{ # A request to perform batch undelete on alerts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

167

"alertId": [ # Required. list of alert IDs.

168

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

169

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

170

"customerId": "A String", # Optional. The unique identifier of the G Suite organization account of the

171

# customer the alerts are associated with.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

172

}

173

174

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

181

182

{ # Response to batch undelete operation on alerts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

183

"failedAlertStatus": { # The status details for each failed alert_id.

184

"a_key": { # The `Status` type defines a logical error model that is suitable for

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

185

# different programming environments, including REST APIs and RPC APIs. It is

186

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

187

# three pieces of data: error code, error message, and error details.

188

#

189

# You can find out more about this error model and how to work with it in the

190

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

191

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

192

"details": [ # A list of messages that carry the error details. There is a common set of

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

193

# message types for APIs to use.

194

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

195

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

196

},

197

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

198

"message": "A String", # A developer-facing error message, which should be in English. Any

199

# user-facing error message should be localized and sent in the

200

# google.rpc.Status.details field, or localized by the client.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

201

},

202

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

203

"successAlertIds": [ # The successful list of alert IDs.

204

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

210

<code class="details" id="delete">delete(alertId, customerId=None, x__xgafv=None)</code>

211

<pre>Marks the specified alert for deletion. An alert that has been marked for

212

deletion is removed from Alert Center after 30 days.

213

Marking an alert for deletion has no effect on an alert which has

214

already been marked for deletion. Attempting to mark a nonexistent alert

215

for deletion results in a `NOT_FOUND` error.

216

217

Args:

218

alertId: string, Required. The identifier of the alert to delete. (required)

219

customerId: string, Optional. The unique identifier of the G Suite organization account of the

220

customer the alert is associated with.

221

Inferred from the caller identity if not provided.

222

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

229

230

{ # A generic empty message that you can re-use to avoid defining duplicated

231

# empty messages in your APIs. A typical example is to use it as the request

232

# or the response type of an API method. For instance:

233

#

234

# service Foo {

235

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

236

# }

237

#

238

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(alertId, customerId=None, x__xgafv=None)</code>

244

<pre>Gets the specified alert. Attempting to get a nonexistent alert returns

`NOT_FOUND` error.

Args:

alertId: string, Required. The identifier of the alert to retrieve. (required)

249

customerId: string, Optional. The unique identifier of the G Suite organization account of the

250

customer the alert is associated with.

251

Inferred from the caller identity if not provided.

252

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

259

260

{ # An alert affecting a customer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

261

"startTime": "A String", # Required. The time the event that caused this alert was started or

262

# detected.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

263

"createTime": "A String", # Output only. The time this alert was created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

264

"data": { # Optional. The data associated with this alert, for example

265

# google.apps.alertcenter.type.DeviceCompromised.

266

"a_key": "", # Properties of the object. Contains field @type with type URL.

267

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

268

"endTime": "A String", # Optional. The time the event that caused this alert ceased being active.

269

# If provided, the end time must not be earlier than the start time.

270

# If not provided, it indicates an ongoing alert.

271

"alertId": "A String", # Output only. The unique identifier for the alert.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

272

"metadata": { # An alert metadata. # Output only. The metadata associated with this alert.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

273

"alertId": "A String", # Output only. The alert identifier.

274

"updateTime": "A String", # Output only. The time this metadata was last updated.

275

"assignee": "A String", # The email address of the user assigned to the alert.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

276

"severity": "A String", # The severity value of the alert. Alert Center will set this field at alert

277

# creation time, default's to an empty string when it could not be

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

278

# determined.

279

# The supported values for update actions on this field are the following:

#

# * HIGH

# * MEDIUM

# * LOW

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

284

"status": "A String", # The current status of the alert.

285

# The supported values are the following:

#

# * NOT_STARTED

# * IN_PROGRESS

# * CLOSED

"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

291

"etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

292

# help prevent simultaneous updates of an alert metadata from overwriting

293

# each other. It is strongly suggested that systems make use of the `etag` in

294

# the read-modify-write cycle to perform metatdata updates in order to avoid

295

# race conditions: An `etag` is returned in the response which contains alert

296

# metadata, and systems are expected to put that etag in the request to

297

# update alert metadata to ensure that their change will be applied to the

298

# same version of the alert metadata.

299

#

300

# If no `etag` is provided in the call to update alert metadata, then the

301

# existing alert metadata is overwritten blindly.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

302

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

303

"source": "A String", # Required. A unique identifier for the system that reported the alert.

304

# This is output only after alert is created.

305

#

306

# Supported sources are any of the following:

307

#

308

# * Google Operations

309

# * Mobile device management

310

# * Gmail phishing

311

# * Domain wide takeout

312

# * State sponsored attack

313

# * Google identity

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

314

"securityInvestigationToolLink": "A String", # Output only. An optional

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

315

# [Security Investigation Tool](https://support.google.com/a/answer/7575955)

316

# query for this alert.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

317

"updateTime": "A String", # Output only. The time this alert was last updated.

318

"etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to help

319

# prevent simultaneous updates of an alert from overwriting each other.

320

# It is strongly suggested that systems make use of the `etag` in the

321

# read-modify-write cycle to perform alert updates in order to avoid race

322

# conditions: An `etag` is returned in the response which contains alerts,

323

# and systems are expected to put that etag in the request to update alert to

324

# ensure that their change will be applied to the same version of the alert.

325

#

326

# If no `etag` is provided in the call to update alert, then the existing

327

# alert is overwritten blindly.

328

"deleted": True or False, # Output only. `True` if this alert is marked for deletion.

329

"type": "A String", # Required. The type of the alert.

330

# This is output only after alert is created.

331

# For a list of available alert types see

332

# [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).

333

"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

338

<code class="details" id="getMetadata">getMetadata(alertId, customerId=None, x__xgafv=None)</code>

339

<pre>Returns the metadata of an alert. Attempting to get metadata for

340

a non-existent alert returns `NOT_FOUND` error.

341

342

Args:

343

alertId: string, Required. The identifier of the alert this metadata belongs to. (required)

344

customerId: string, Optional. The unique identifier of the G Suite organization account of the

345

customer the alert metadata is associated with.

346

Inferred from the caller identity if not provided.

347

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

354

355

{ # An alert metadata.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

356

"alertId": "A String", # Output only. The alert identifier.

357

"updateTime": "A String", # Output only. The time this metadata was last updated.

358

"assignee": "A String", # The email address of the user assigned to the alert.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

359

"severity": "A String", # The severity value of the alert. Alert Center will set this field at alert

360

# creation time, default's to an empty string when it could not be

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

361

# determined.

362

# The supported values for update actions on this field are the following:

#

# * HIGH

# * MEDIUM

# * LOW

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

367

"status": "A String", # The current status of the alert.

368

# The supported values are the following:

#

# * NOT_STARTED

# * IN_PROGRESS

# * CLOSED

"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

374

"etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

375

# help prevent simultaneous updates of an alert metadata from overwriting

376

# each other. It is strongly suggested that systems make use of the `etag` in

377

# the read-modify-write cycle to perform metatdata updates in order to avoid

378

# race conditions: An `etag` is returned in the response which contains alert

379

# metadata, and systems are expected to put that etag in the request to

380

# update alert metadata to ensure that their change will be applied to the

381

# same version of the alert metadata.

382

#

383

# If no `etag` is provided in the call to update alert metadata, then the

384

# existing alert metadata is overwritten blindly.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

389

<code class="details" id="list">list(pageSize=None, pageToken=None, orderBy=None, customerId=None, filter=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

390

<pre>Lists the alerts.

391

392

Args:

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

393

pageSize: integer, Optional. The requested page size. Server may return fewer items than

394

requested. If unspecified, server picks an appropriate default.

395

pageToken: string, Optional. A token identifying a page of results the server should return.

396

If empty, a new iteration is started. To continue an iteration, pass in

397

the value from the previous ListAlertsResponse's

398

next_page_token field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

399

orderBy: string, Optional. The sort order of the list results.

400

If not specified results may be returned in arbitrary order.

401

You can sort the results in descending order based on the creation

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

402

timestamp using `order_by="create_time desc"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

403

Currently, supported sorting are `create_time asc`, `create_time desc`,

404

`update_time desc`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

405

customerId: string, Optional. The unique identifier of the G Suite organization account of the

406

customer the alerts are associated with.

407

Inferred from the caller identity if not provided.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

408

filter: string, Optional. A query string for filtering alert results.

409

For more details, see [Query

410

filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported

411

query filter

412

fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

413

x__xgafv: string, V1 error format.

414

Allowed values

415

1 - v1 error format

416

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

417

418

Returns:

419

An object of the form:

420

421

{ # Response message for an alert listing request.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

422

"nextPageToken": "A String", # The token for the next page. If not empty, indicates that there may be more

423

# alerts that match the listing request; this value can be used in a

424

# subsequent ListAlertsRequest to get alerts continuing from last result

425

# of the current list call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

426

"alerts": [ # The list of alerts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

427

{ # An alert affecting a customer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

428

"startTime": "A String", # Required. The time the event that caused this alert was started or

429

# detected.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

430

"createTime": "A String", # Output only. The time this alert was created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

431

"data": { # Optional. The data associated with this alert, for example

432

# google.apps.alertcenter.type.DeviceCompromised.

433

"a_key": "", # Properties of the object. Contains field @type with type URL.

434

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

435

"endTime": "A String", # Optional. The time the event that caused this alert ceased being active.

436

# If provided, the end time must not be earlier than the start time.

437

# If not provided, it indicates an ongoing alert.

438

"alertId": "A String", # Output only. The unique identifier for the alert.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

439

"metadata": { # An alert metadata. # Output only. The metadata associated with this alert.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

440

"alertId": "A String", # Output only. The alert identifier.

441

"updateTime": "A String", # Output only. The time this metadata was last updated.

442

"assignee": "A String", # The email address of the user assigned to the alert.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

443

"severity": "A String", # The severity value of the alert. Alert Center will set this field at alert

444

# creation time, default's to an empty string when it could not be

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

445

# determined.

446

# The supported values for update actions on this field are the following:

#

# * HIGH

# * MEDIUM

# * LOW

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

451

"status": "A String", # The current status of the alert.

452

# The supported values are the following:

#

# * NOT_STARTED

# * IN_PROGRESS

# * CLOSED

"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

458

"etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

459

# help prevent simultaneous updates of an alert metadata from overwriting

460

# each other. It is strongly suggested that systems make use of the `etag` in

461

# the read-modify-write cycle to perform metatdata updates in order to avoid

462

# race conditions: An `etag` is returned in the response which contains alert

463

# metadata, and systems are expected to put that etag in the request to

464

# update alert metadata to ensure that their change will be applied to the

465

# same version of the alert metadata.

466

#

467

# If no `etag` is provided in the call to update alert metadata, then the

468

# existing alert metadata is overwritten blindly.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

469

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

470

"source": "A String", # Required. A unique identifier for the system that reported the alert.

471

# This is output only after alert is created.

472

#

473

# Supported sources are any of the following:

474

#

475

# * Google Operations

476

# * Mobile device management

477

# * Gmail phishing

478

# * Domain wide takeout

479

# * State sponsored attack

480

# * Google identity

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

481

"securityInvestigationToolLink": "A String", # Output only. An optional

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

482

# [Security Investigation Tool](https://support.google.com/a/answer/7575955)

483

# query for this alert.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

484

"updateTime": "A String", # Output only. The time this alert was last updated.

485

"etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to help

486

# prevent simultaneous updates of an alert from overwriting each other.

487

# It is strongly suggested that systems make use of the `etag` in the

488

# read-modify-write cycle to perform alert updates in order to avoid race

489

# conditions: An `etag` is returned in the response which contains alerts,

490

# and systems are expected to put that etag in the request to update alert to

491

# ensure that their change will be applied to the same version of the alert.

492

#

493

# If no `etag` is provided in the call to update alert, then the existing

494

# alert is overwritten blindly.

495

"deleted": True or False, # Output only. `True` if this alert is marked for deletion.

496

"type": "A String", # Required. The type of the alert.

497

# This is output only after alert is created.

498

# For a list of available alert types see

499

# [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).

500

"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

508

<pre>Retrieves the next page of results.

509

510

Args:

511

previous_request: The request for the previous page. (required)

512

previous_response: The response from the request for the previous page. (required)

513

514

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

515

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

516

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

521

<code class="details" id="undelete">undelete(alertId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

522

<pre>Restores, or "undeletes", an alert that was marked for deletion within the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

523

past 30 days. Attempting to undelete an alert which was marked for deletion

524

over 30 days ago (which has been removed from the Alert Center database) or

525

a nonexistent alert returns a `NOT_FOUND` error. Attempting to

526

undelete an alert which has not been marked for deletion has no effect.

527

528

Args:

529

alertId: string, Required. The identifier of the alert to undelete. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

530

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

531

The object takes the form of:

532

533

{ # A request to undelete a specific alert that was marked for deletion.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

534

"customerId": "A String", # Optional. The unique identifier of the G Suite organization account of the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

535

# customer the alert is associated with.

536

# Inferred from the caller identity if not provided.

537

}

538

539

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

546

547

{ # An alert affecting a customer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

548

"startTime": "A String", # Required. The time the event that caused this alert was started or

549

# detected.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

550

"createTime": "A String", # Output only. The time this alert was created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

551

"data": { # Optional. The data associated with this alert, for example

552

# google.apps.alertcenter.type.DeviceCompromised.

553

"a_key": "", # Properties of the object. Contains field @type with type URL.

554

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

555

"endTime": "A String", # Optional. The time the event that caused this alert ceased being active.

556

# If provided, the end time must not be earlier than the start time.

557

# If not provided, it indicates an ongoing alert.

558

"alertId": "A String", # Output only. The unique identifier for the alert.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

559

"metadata": { # An alert metadata. # Output only. The metadata associated with this alert.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

560

"alertId": "A String", # Output only. The alert identifier.

561

"updateTime": "A String", # Output only. The time this metadata was last updated.

562

"assignee": "A String", # The email address of the user assigned to the alert.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

563

"severity": "A String", # The severity value of the alert. Alert Center will set this field at alert

564

# creation time, default's to an empty string when it could not be

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

565

# determined.

566

# The supported values for update actions on this field are the following:

#

# * HIGH

# * MEDIUM

# * LOW

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

571

"status": "A String", # The current status of the alert.

572

# The supported values are the following:

#

# * NOT_STARTED

# * IN_PROGRESS

# * CLOSED

"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

578

"etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

579

# help prevent simultaneous updates of an alert metadata from overwriting

580

# each other. It is strongly suggested that systems make use of the `etag` in

581

# the read-modify-write cycle to perform metatdata updates in order to avoid

582

# race conditions: An `etag` is returned in the response which contains alert

583

# metadata, and systems are expected to put that etag in the request to

584

# update alert metadata to ensure that their change will be applied to the

585

# same version of the alert metadata.

586

#

587

# If no `etag` is provided in the call to update alert metadata, then the

588

# existing alert metadata is overwritten blindly.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

589

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

590

"source": "A String", # Required. A unique identifier for the system that reported the alert.

591

# This is output only after alert is created.

592

#

593

# Supported sources are any of the following:

594

#

595

# * Google Operations

596

# * Mobile device management

597

# * Gmail phishing

598

# * Domain wide takeout

599

# * State sponsored attack

600

# * Google identity

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

601

"securityInvestigationToolLink": "A String", # Output only. An optional

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

602

# [Security Investigation Tool](https://support.google.com/a/answer/7575955)

603

# query for this alert.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

604

"updateTime": "A String", # Output only. The time this alert was last updated.

605

"etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to help

606

# prevent simultaneous updates of an alert from overwriting each other.

607

# It is strongly suggested that systems make use of the `etag` in the

608

# read-modify-write cycle to perform alert updates in order to avoid race

609

# conditions: An `etag` is returned in the response which contains alerts,

610

# and systems are expected to put that etag in the request to update alert to

611

# ensure that their change will be applied to the same version of the alert.

612

#

613

# If no `etag` is provided in the call to update alert, then the existing

614

# alert is overwritten blindly.

615

"deleted": True or False, # Output only. `True` if this alert is marked for deletion.

616

"type": "A String", # Required. The type of the alert.

617

# This is output only after alert is created.

618

# For a list of available alert types see

619

# [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).

620

"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.

Bu Sun Kim