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-07-22 17:02:09 -0700

[diff] [blame^]

98

<code><a href="#list">list(orderBy=None, customerId=None, pageSize=None, pageToken=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-07-22 17:02:09 -0700

[diff] [blame^]

116

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

117

# customer the alerts are associated with.

Bu Sun Kim

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

[diff] [blame]

118

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

119

"A String",

Dan O'Meara

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

[diff] [blame]

],

}

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-20 12:08:20 -0700

[diff] [blame]

132

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

133

"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]

134

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

135

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

136

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

137

#

138

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

139

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

Bu Sun Kim

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

[diff] [blame]

140

"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]

141

# message types for APIs to use.

142

{

Bu Sun Kim

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

[diff] [blame]

143

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

Dan O'Meara

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

[diff] [blame]

144

},

145

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

146

"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]

147

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

148

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

149

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

Dan O'Meara

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

[diff] [blame]

150

},

151

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

152

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

153

"A String",

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-20 12:08:20 -0700

[diff] [blame]

191

"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]

192

# message types for APIs to use.

193

{

Bu Sun Kim

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

[diff] [blame]

194

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

Dan O'Meara

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

[diff] [blame]

195

},

196

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

197

"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]

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-07-22 17:02:09 -0700

[diff] [blame^]

261

"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]

262

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

263

# google.apps.alertcenter.type.DeviceCompromised.

264

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

265

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

#

274

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

275

# alert is overwritten blindly.

276

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

277

# detected.

278

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

279

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

280

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

281

# query for this alert.

Bu Sun Kim

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

[diff] [blame]

282

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

Bu Sun Kim

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

[diff] [blame]

283

"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]

284

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

285

# 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]

286

# determined.

287

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

#

# * HIGH

# * MEDIUM

# * LOW

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

292

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

Bu Sun Kim

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

[diff] [blame]

293

"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]

294

# help prevent simultaneous updates of an alert metadata from overwriting

295

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

296

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

297

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

298

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

299

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

300

# same version of the alert metadata.

301

#

302

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

303

# existing alert metadata is overwritten blindly.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

304

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

305

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

306

# 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

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

[diff] [blame]

312

},

Bu Sun Kim

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

[diff] [blame]

313

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

314

# This is output only after alert is created.

315

#

316

# Supported sources are any of the following:

317

#

318

# * Google Operations

319

# * Mobile device management

320

# * Gmail phishing

321

# * Domain wide takeout

322

# * State sponsored attack

323

# * Google identity

Bu Sun Kim

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

[diff] [blame]

324

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

Bu Sun Kim

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

[diff] [blame]

325

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

326

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

327

# This is output only after alert is created.

328

# For a list of available alert types see

329

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

330

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

331

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

332

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

333

# If not provided, it indicates an ongoing alert.

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

"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]

357

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

358

# 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]

359

# determined.

360

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

#

# * HIGH

# * MEDIUM

# * LOW

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

365

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

Bu Sun Kim

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

[diff] [blame]

366

"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]

367

# help prevent simultaneous updates of an alert metadata from overwriting

368

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

369

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

370

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

371

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

372

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

373

# same version of the alert metadata.

374

#

375

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

376

# existing alert metadata is overwritten blindly.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

377

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

378

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

379

# 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.

Dan O'Meara

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

389

<code class="details" id="list">list(orderBy=None, customerId=None, pageSize=None, pageToken=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:

393

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

394

If not specified results may be returned in arbitrary order.

395

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

Bu Sun Kim

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

[diff] [blame]

396

timestamp using `order_by="create_time desc"`.

Bu Sun Kim

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

[diff] [blame]

397

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

398

`update_time desc`

Bu Sun Kim

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

[diff] [blame]

399

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

400

customer the alerts are associated with.

401

Inferred from the caller identity if not provided.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

402

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

403

requested. If unspecified, server picks an appropriate default.

404

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

405

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

406

the value from the previous ListAlertsResponse's

407

next_page_token field.

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-20 12:08:20 -0700

[diff] [blame]

422

"alerts": [ # The list of alerts.

Bu Sun Kim

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

[diff] [blame]

423

{ # An alert affecting a customer.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

424

"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]

425

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

426

# google.apps.alertcenter.type.DeviceCompromised.

427

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

428

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

#

437

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

438

# alert is overwritten blindly.

439

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

440

# detected.

441

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

442

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

443

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

444

# query for this alert.

Bu Sun Kim

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

[diff] [blame]

445

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

Bu Sun Kim

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

[diff] [blame]

446

"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]

447

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

448

# 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]

449

# determined.

450

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

#

# * HIGH

# * MEDIUM

# * LOW

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

455

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

Bu Sun Kim

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

[diff] [blame]

456

"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]

457

# help prevent simultaneous updates of an alert metadata from overwriting

458

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

459

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

460

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

461

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

462

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

463

# same version of the alert metadata.

464

#

465

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

466

# existing alert metadata is overwritten blindly.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

467

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

468

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

469

# 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

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

[diff] [blame]

475

},

Bu Sun Kim

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

[diff] [blame]

476

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

477

# This is output only after alert is created.

478

#

479

# Supported sources are any of the following:

480

#

481

# * Google Operations

482

# * Mobile device management

483

# * Gmail phishing

484

# * Domain wide takeout

485

# * State sponsored attack

486

# * Google identity

Bu Sun Kim

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

[diff] [blame]

487

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

Bu Sun Kim

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

[diff] [blame]

488

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

489

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

490

# This is output only after alert is created.

491

# For a list of available alert types see

492

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

493

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

494

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

495

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

496

# If not provided, it indicates an ongoing alert.

Bu Sun Kim

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

[diff] [blame]

497

},

498

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

499

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

500

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

501

# subsequent ListAlertsRequest to get alerts continuing from last result

502

# of the current list call.

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-07-22 17:02:09 -0700

[diff] [blame^]

548

"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]

549

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

550

# google.apps.alertcenter.type.DeviceCompromised.

551

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

552

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

553

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

554

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

555

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

556

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

557

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

558

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

559

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

560

#

561

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

562

# alert is overwritten blindly.

563

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

564

# detected.

565

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

566

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

567

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

568

# query for this alert.

Bu Sun Kim

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

[diff] [blame]

569

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

Bu Sun Kim

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

[diff] [blame]

570

"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]

571

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

572

# 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]

573

# determined.

574

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

#

# * HIGH

# * MEDIUM

# * LOW

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

579

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

Bu Sun Kim

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

[diff] [blame]

580

"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]

581

# help prevent simultaneous updates of an alert metadata from overwriting

582

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

583

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

584

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

585

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

586

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

587

# same version of the alert metadata.

588

#

589

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

590

# existing alert metadata is overwritten blindly.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

591

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

592

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

593

# 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

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

[diff] [blame]

599

},

Bu Sun Kim

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

[diff] [blame]

600

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

601

# This is output only after alert is created.

602

#

603

# Supported sources are any of the following:

604

#

605

# * Google Operations

606

# * Mobile device management

607

# * Gmail phishing

608

# * Domain wide takeout

609

# * State sponsored attack

610

# * Google identity

Bu Sun Kim

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

[diff] [blame]

611

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

Bu Sun Kim

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

[diff] [blame]

612

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

613

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

614

# This is output only after alert is created.

615

# For a list of available alert types see

616

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

617

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

618

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

619

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

620

# If not provided, it indicates an ongoing alert.

Bu Sun Kim