Blame - docs/dyn/websecurityscanner_v1.projects.scanConfigs.html - platform/external/python/google-api-python-client

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

[diff] [blame]

115

"riskLevel": "A String", # The risk level selected for the scan

116

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

117

# inclusively. If the field is unspecified or its value is set 0, server will

118

# default to 15. Other values outside of [5, 20] range will be rejected with

119

# INVALID_ARGUMENT error.

120

"blacklistPatterns": [ # The excluded URL patterns as described in

121

# https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

122

"A String",

123

],

124

"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security

125

# Command Center.

126

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

127

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

128

# generated by the system.

129

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

130

"userAgent": "A String", # The user agent used during scanning.

131

"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output

132

# only.

133

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

134

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

135

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

136

# refreshed by the server after each run. If unspecified, it will default

137

# to current server time, which means the scan will be scheduled to start

138

# immediately.

Bu Sun Kim

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

[diff] [blame]

139

},

Bu Sun Kim

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

[diff] [blame]

140

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

141

"A String",

142

],

143

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.

144

# If enabled, the scanner will access applications from static IP addresses.

145

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the

146

# authentication configuration during scanning.

147

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

148

"loginUrl": "A String", # Required. The login form URL of the website.

149

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

150

# and not returned in any response nor included in audit logs.

151

"username": "A String", # Required. The user name of the custom account.

152

},

153

"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).

154

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service

155

# account is added in Identity-Aware-Proxy (IAP) access policies.

156

# service account is added in Identity-Aware-Proxy (IAP) access policies.

157

"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by

158

# Identity-Aware-Proxy (IAP).

159

},

160

},

161

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

162

"username": "A String", # Required. The user name of the Google account.

163

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

164

# and not returned in any response nor included in audit logs.

Bu Sun Kim

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

[diff] [blame]

165

},

166

},

Bu Sun Kim

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

[diff] [blame]

167

}

Bu Sun Kim

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

[diff] [blame]

168

169

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

176

177

{ # A ScanConfig resource contains the configurations to launch a scan.

Bu Sun Kim

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

[diff] [blame]

178

"riskLevel": "A String", # The risk level selected for the scan

179

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

180

# inclusively. If the field is unspecified or its value is set 0, server will

181

# default to 15. Other values outside of [5, 20] range will be rejected with

182

# INVALID_ARGUMENT error.

183

"blacklistPatterns": [ # The excluded URL patterns as described in

184

# https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

185

"A String",

186

],

187

"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security

188

# Command Center.

189

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

190

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

191

# generated by the system.

192

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

193

"userAgent": "A String", # The user agent used during scanning.

194

"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output

195

# only.

196

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

197

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

198

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

199

# refreshed by the server after each run. If unspecified, it will default

200

# to current server time, which means the scan will be scheduled to start

201

# immediately.

Bu Sun Kim

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

[diff] [blame]

202

},

Bu Sun Kim

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

[diff] [blame]

203

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

204

"A String",

205

],

206

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.

207

# If enabled, the scanner will access applications from static IP addresses.

208

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the

209

# authentication configuration during scanning.

210

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

211

"loginUrl": "A String", # Required. The login form URL of the website.

212

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

213

# and not returned in any response nor included in audit logs.

214

"username": "A String", # Required. The user name of the custom account.

215

},

216

"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).

217

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service

218

# account is added in Identity-Aware-Proxy (IAP) access policies.

219

# service account is added in Identity-Aware-Proxy (IAP) access policies.

220

"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by

221

# Identity-Aware-Proxy (IAP).

222

},

223

},

224

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

225

"username": "A String", # Required. The user name of the Google account.

226

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

227

# and not returned in any response nor included in audit logs.

Bu Sun Kim

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

[diff] [blame]

228

},

229

},

Bu Sun Kim

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

[diff] [blame]

230

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

235

<pre>Deletes an existing ScanConfig and its child resources.

236

237

Args:

238

name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the

239

format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

240

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

247

248

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

249

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

250

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

251

#

252

# service Foo {

253

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

254

# }

255

#

256

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

}</pre>

</div>

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

262

<pre>Gets a ScanConfig.

263

264

Args:

265

name: string, Required. The resource name of the ScanConfig to be returned. The name follows the

266

format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

267

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

274

275

{ # A ScanConfig resource contains the configurations to launch a scan.

Bu Sun Kim

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

[diff] [blame]

276

"riskLevel": "A String", # The risk level selected for the scan

277

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

278

# inclusively. If the field is unspecified or its value is set 0, server will

279

# default to 15. Other values outside of [5, 20] range will be rejected with

280

# INVALID_ARGUMENT error.

281

"blacklistPatterns": [ # The excluded URL patterns as described in

282

# https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

283

"A String",

284

],

285

"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security

286

# Command Center.

287

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

288

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

289

# generated by the system.

290

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

291

"userAgent": "A String", # The user agent used during scanning.

292

"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output

293

# only.

294

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

295

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

296

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

297

# refreshed by the server after each run. If unspecified, it will default

298

# to current server time, which means the scan will be scheduled to start

299

# immediately.

Bu Sun Kim

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

[diff] [blame]

300

},

Bu Sun Kim

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

[diff] [blame]

301

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

302

"A String",

303

],

304

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.

305

# If enabled, the scanner will access applications from static IP addresses.

306

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the

307

# authentication configuration during scanning.

308

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

309

"loginUrl": "A String", # Required. The login form URL of the website.

310

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

311

# and not returned in any response nor included in audit logs.

312

"username": "A String", # Required. The user name of the custom account.

313

},

314

"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).

315

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service

316

# account is added in Identity-Aware-Proxy (IAP) access policies.

317

# service account is added in Identity-Aware-Proxy (IAP) access policies.

318

"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by

319

# Identity-Aware-Proxy (IAP).

320

},

321

},

322

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

323

"username": "A String", # Required. The user name of the Google account.

324

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

325

# and not returned in any response nor included in audit logs.

Bu Sun Kim

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

[diff] [blame]

326

},

327

},

Bu Sun Kim

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

[diff] [blame]

328

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

333

<pre>Lists ScanConfigs under a given project.

334

335

Args:

336

parent: string, Required. The parent resource name, which should be a project resource name in the

337

format 'projects/{projectId}'. (required)

338

pageToken: string, A token identifying a page of results to be returned. This should be a

339

`next_page_token` value returned from a previous List request.

340

If unspecified, the first page of results is returned.

341

pageSize: integer, The maximum number of ScanConfigs to return, can be limited by server.

342

If not specified or not positive, the implementation will select a

343

reasonable value.

344

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

351

352

{ # Response for the `ListScanConfigs` method.

353

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no

354

# more results in the list.

355

"scanConfigs": [ # The list of ScanConfigs returned.

356

{ # A ScanConfig resource contains the configurations to launch a scan.

Bu Sun Kim

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

[diff] [blame]

357

"riskLevel": "A String", # The risk level selected for the scan

358

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

359

# inclusively. If the field is unspecified or its value is set 0, server will

360

# default to 15. Other values outside of [5, 20] range will be rejected with

361

# INVALID_ARGUMENT error.

362

"blacklistPatterns": [ # The excluded URL patterns as described in

363

# https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

364

"A String",

365

],

366

"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security

367

# Command Center.

368

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

369

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

370

# generated by the system.

371

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

372

"userAgent": "A String", # The user agent used during scanning.

373

"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output

374

# only.

375

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

376

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

377

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

378

# refreshed by the server after each run. If unspecified, it will default

379

# to current server time, which means the scan will be scheduled to start

380

# immediately.

Bu Sun Kim

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

[diff] [blame]

381

},

Bu Sun Kim

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

[diff] [blame]

382

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

383

"A String",

384

],

385

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.

386

# If enabled, the scanner will access applications from static IP addresses.

387

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the

388

# authentication configuration during scanning.

389

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

390

"loginUrl": "A String", # Required. The login form URL of the website.

391

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

392

# and not returned in any response nor included in audit logs.

393

"username": "A String", # Required. The user name of the custom account.

394

},

395

"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).

396

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service

397

# account is added in Identity-Aware-Proxy (IAP) access policies.

398

# service account is added in Identity-Aware-Proxy (IAP) access policies.

399

"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by

400

# Identity-Aware-Proxy (IAP).

401

},

402

},

403

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

404

"username": "A String", # Required. The user name of the Google account.

405

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

406

# and not returned in any response nor included in audit logs.

Bu Sun Kim

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

[diff] [blame]

407

},

408

},

Bu Sun Kim

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

[diff] [blame]

409

},

Bu Sun Kim

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

[diff] [blame]

],

}</pre>

</div>

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

416

<pre>Retrieves the next page of results.

417

418

Args:

419

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

420

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

421

422

Returns:

423

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

424

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

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

430

<pre>Updates a ScanConfig. This method support partial update of a ScanConfig.

431

432

Args:

433

name: string, The resource name of the ScanConfig. The name follows the format of

434

'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

435

generated by the system. (required)

436

body: object, The request body.

437

The object takes the form of:

438

439

{ # A ScanConfig resource contains the configurations to launch a scan.

Bu Sun Kim

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

[diff] [blame]

440

"riskLevel": "A String", # The risk level selected for the scan

441

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

442

# inclusively. If the field is unspecified or its value is set 0, server will

443

# default to 15. Other values outside of [5, 20] range will be rejected with

444

# INVALID_ARGUMENT error.

445

"blacklistPatterns": [ # The excluded URL patterns as described in

446

# https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

447

"A String",

448

],

449

"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security

450

# Command Center.

451

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

452

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

453

# generated by the system.

454

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

455

"userAgent": "A String", # The user agent used during scanning.

456

"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output

457

# only.

458

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

459

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

460

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

461

# refreshed by the server after each run. If unspecified, it will default

462

# to current server time, which means the scan will be scheduled to start

463

# immediately.

Bu Sun Kim

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

[diff] [blame]

464

},

Bu Sun Kim

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

[diff] [blame]

465

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

466

"A String",

467

],

468

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.

469

# If enabled, the scanner will access applications from static IP addresses.

470

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the

471

# authentication configuration during scanning.

472

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

473

"loginUrl": "A String", # Required. The login form URL of the website.

474

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

475

# and not returned in any response nor included in audit logs.

476

"username": "A String", # Required. The user name of the custom account.

477

},

478

"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).

479

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service

480

# account is added in Identity-Aware-Proxy (IAP) access policies.

481

# service account is added in Identity-Aware-Proxy (IAP) access policies.

482

"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by

483

# Identity-Aware-Proxy (IAP).

484

},

485

},

486

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

487

"username": "A String", # Required. The user name of the Google account.

488

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

489

# and not returned in any response nor included in audit logs.

Bu Sun Kim

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

[diff] [blame]

490

},

491

},

Bu Sun Kim

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

[diff] [blame]

492

}

Bu Sun Kim

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

[diff] [blame]

493

494

updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition,

495

see

496

https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

497

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

504

505

{ # A ScanConfig resource contains the configurations to launch a scan.

Bu Sun Kim

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

[diff] [blame]

506

"riskLevel": "A String", # The risk level selected for the scan

507

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

508

# inclusively. If the field is unspecified or its value is set 0, server will

509

# default to 15. Other values outside of [5, 20] range will be rejected with

510

# INVALID_ARGUMENT error.

511

"blacklistPatterns": [ # The excluded URL patterns as described in

512

# https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

513

"A String",

514

],

515

"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security

516

# Command Center.

517

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

518

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

519

# generated by the system.

520

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

521

"userAgent": "A String", # The user agent used during scanning.

522

"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output

523

# only.

524

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

525

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

526

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

527

# refreshed by the server after each run. If unspecified, it will default

528

# to current server time, which means the scan will be scheduled to start

529

# immediately.

Bu Sun Kim

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

[diff] [blame]

530

},

Bu Sun Kim

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

[diff] [blame]

531

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

532

"A String",

533

],

534

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.

535

# If enabled, the scanner will access applications from static IP addresses.

536

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the

537

# authentication configuration during scanning.

538

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

539

"loginUrl": "A String", # Required. The login form URL of the website.

540

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

541

# and not returned in any response nor included in audit logs.

542

"username": "A String", # Required. The user name of the custom account.

543

},

544

"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).

545

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service

546

# account is added in Identity-Aware-Proxy (IAP) access policies.

547

# service account is added in Identity-Aware-Proxy (IAP) access policies.

548

"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by

549

# Identity-Aware-Proxy (IAP).

550

},

551

},

552

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

553

"username": "A String", # Required. The user name of the Google account.

554

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

555

# and not returned in any response nor included in audit logs.

Bu Sun Kim

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

[diff] [blame]

556

},

557

},

Bu Sun Kim

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

[diff] [blame]

558

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

563

<pre>Start a ScanRun according to the given ScanConfig.

564

565

Args:

566

name: string, Required. The resource name of the ScanConfig to be used. The name follows the

567

format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

568

body: object, The request body.

569

The object takes the form of:

570

571

{ # Request for the `StartScanRun` method.

572

}

573

574

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

581

582

{ # A ScanRun is a output-only resource representing an actual run of the scan.

583

# Next id: 12

Bu Sun Kim

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

[diff] [blame]

584

"errorTrace": { # Output only. # Output only. If result_state is an ERROR, this field provides the primary reason for

585

# scan's termination and more details, if such are available.

586

# Defines an error trace message for a ScanRun.

Bu Sun Kim

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

[diff] [blame]

587

"mostCommonHttpErrorCode": 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most

588

# common HTTP error code, if such is available. For example, if this code is

589

# 404, the scan has encountered too many NOT_FOUND responses.

Bu Sun Kim

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

[diff] [blame]

590

"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error

591

# message encountered during scan configuration validation that is performed

592

# before each scan run.

593

# APIs when scan configuration validation fails. It is also reported as part of

594

# a ScanRunErrorTrace message if scan validation fails due to a scan

595

# configuration error.

596

"fieldName": "A String", # Output only. Indicates the full name of the ScanConfig field that triggers this error,

597

# for example "scan_config.max_qps". This field is provided for

598

# troubleshooting purposes only and its actual value can change in the

599

# future.

Bu Sun Kim

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

[diff] [blame]

600

"code": "A String", # Output only. Indicates the reason code for a configuration failure.

Bu Sun Kim

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

[diff] [blame]

601

},

Bu Sun Kim

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

[diff] [blame]

602

"code": "A String", # Output only. Indicates the error reason code.

Bu Sun Kim

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

[diff] [blame]

603

},

Bu Sun Kim

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

[diff] [blame]

604

"urlsCrawledCount": "A String", # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress,

605

# the value represents the number of URLs crawled up to now.

Bu Sun Kim

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

[diff] [blame]

606

"warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.

607

{ # Output only.

608

# Defines a warning trace message for ScanRun. Warning traces provide customers

609

# with useful information that helps make the scanning process more effective.

610

"code": "A String", # Output only. Indicates the warning code.

611

},

612

],

Bu Sun Kim

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

[diff] [blame]

613

"resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the

614

# execution state reaches "FINISHED".

Bu Sun Kim

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

[diff] [blame]

615

"executionState": "A String", # Output only. The execution state of the ScanRun.

616

"urlsTestedCount": "A String", # Output only. The number of URLs tested during this ScanRun. If the scan is in progress,

617

# the value represents the number of URLs tested up to now. The number of

618

# URLs tested is usually larger than the number URLS crawled because

619

# typically a crawled URL is tested with multiple test payloads.

Bu Sun Kim

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

[diff] [blame]

620

"name": "A String", # Output only. The resource name of the ScanRun. The name follows the format of

621

# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

622

# The ScanRun IDs are generated by the system.

Bu Sun Kim

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

[diff] [blame]

623

"hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.

624

"endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun

625

# is either finished or stopped by user.

626

"progressPercent": 42, # Output only. The percentage of total completion ranging from 0 to 100.

627

# If the scan is in queue, the value is 0.

628

# If the scan is running, the value ranges from 0 to 100.

629

# If the scan is finished, the value is 100.

630

"startTime": "A String", # Output only. The time at which the ScanRun started.

Bu Sun Kim