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

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

[diff] [blame]

83

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

Bu Sun Kim

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

[diff] [blame]

84

<p class="firstline">Creates a new ScanConfig.</p>

85

86

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

87

<p class="firstline">Deletes an existing ScanConfig and its child resources.</p>

88

89

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

90

<p class="firstline">Gets a ScanConfig.</p>

91

Bu Sun Kim

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

[diff] [blame]

92

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

Bu Sun Kim

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

[diff] [blame]

93

<p class="firstline">Lists ScanConfigs under a given project.</p>

94

95

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

96

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

97

Dan O'Meara

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

[diff] [blame]

98

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

Bu Sun Kim

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

[diff] [blame]

99

<p class="firstline">Updates a ScanConfig. This method support partial update of a ScanConfig.</p>

100

101

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

102

<p class="firstline">Start a ScanRun according to the given ScanConfig.</p>

103

<h3>Method Details</h3>

104

Dan O'Meara

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

<pre>Creates a new ScanConfig.

107

108

Args:

Dan O'Meara

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

[diff] [blame]

109

parent: string, Required. The parent resource name where the scan is created, which should be a

Bu Sun Kim

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

[diff] [blame]

110

project resource name in the format 'projects/{projectId}'. (required)

Dan O'Meara

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

[diff] [blame]

111

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

112

The object takes the form of:

113

114

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

Bu Sun Kim

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

[diff] [blame^]

115

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

116

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

117

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

118

# INVALID_ARGUMENT error.

119

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.

120

# Next id: 12

121

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

122

# execution state reaches "FINISHED".

123

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

124

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

125

# Defines an error trace message for a ScanRun.

126

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

127

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

128

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

129

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

130

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

131

# message encountered during scan configuration validation that is performed

132

# before each scan run.

133

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

134

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

135

# configuration error.

136

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

137

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

138

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

139

# future.

140

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

141

},

Bu Sun Kim

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

[diff] [blame]

142

},

Bu Sun Kim

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

[diff] [blame^]

143

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

144

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

145

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

146

# The ScanRun IDs are generated by the system.

147

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

148

{ # Output only.

149

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

150

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

151

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

152

},

153

],

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

# is either finished or stopped by user.

Bu Sun Kim

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

[diff] [blame]

168

},

Bu Sun Kim

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

[diff] [blame^]

169

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

170

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

Bu Sun Kim

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

[diff] [blame]

171

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

172

# only.

Bu Sun Kim

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

[diff] [blame^]

173

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

174

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

175

"A String",

176

],

177

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE

178

# will be used as a default.

179

"A String",

180

],

Bu Sun Kim

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

[diff] [blame]

181

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

Bu Sun Kim

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

[diff] [blame]

182

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

183

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

184

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

185

# immediately.

Bu Sun Kim

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

[diff] [blame^]

186

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

Bu Sun Kim

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

[diff] [blame]

187

},

Bu Sun Kim

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

[diff] [blame^]

188

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

189

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

190

# generated by the system.

191

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

192

# Command Center.

193

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

194

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

195

"A String",

196

],

197

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

Bu Sun Kim

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

[diff] [blame]

198

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

199

# authentication configuration during scanning.

200

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

201

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

202

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

203

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

204

},

205

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

206

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

207

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

208

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

209

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by

210

# Identity-Aware-Proxy(IAP).

211

},

212

},

213

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

214

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

215

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

216

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

217

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

218

},

219

},

Bu Sun Kim

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

[diff] [blame^]

220

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

221

}

222

223

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

230

231

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

232

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

233

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

234

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

235

# INVALID_ARGUMENT error.

236

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.

237

# Next id: 12

238

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

239

# execution state reaches "FINISHED".

240

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

241

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

242

# Defines an error trace message for a ScanRun.

243

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

244

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

245

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

246

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

247

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

248

# message encountered during scan configuration validation that is performed

249

# before each scan run.

250

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

251

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

252

# configuration error.

253

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

254

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

255

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

256

# future.

257

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

258

},

Bu Sun Kim

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

[diff] [blame]

259

},

Bu Sun Kim

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

[diff] [blame^]

260

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

261

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

262

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

263

# The ScanRun IDs are generated by the system.

264

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

265

{ # Output only.

266

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

267

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

268

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

269

},

270

],

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

# is either finished or stopped by user.

Bu Sun Kim

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

[diff] [blame]

285

},

Bu Sun Kim

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

[diff] [blame^]

286

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

287

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

288

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

289

# only.

290

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

291

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

292

"A String",

293

],

294

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE

295

# will be used as a default.

296

"A String",

297

],

298

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

299

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

300

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

301

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

302

# immediately.

303

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

304

},

305

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

306

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

307

# generated by the system.

308

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

309

# Command Center.

310

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

311

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

312

"A String",

313

],

314

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

315

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

316

# authentication configuration during scanning.

317

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

318

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

319

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

320

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

321

},

322

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

323

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

324

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

325

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

326

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by

327

# Identity-Aware-Proxy(IAP).

328

},

329

},

330

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

331

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

332

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

333

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

334

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

335

},

336

},

337

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

338

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

343

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

344

345

Args:

Dan O'Meara

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

[diff] [blame]

346

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

Bu Sun Kim

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

[diff] [blame]

347

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

Bu Sun Kim

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

[diff] [blame]

348

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

355

356

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

357

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

358

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

359

#

360

# service Foo {

361

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

362

# }

363

#

364

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

}</pre>

</div>

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

370

<pre>Gets a ScanConfig.

371

372

Args:

Dan O'Meara

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

[diff] [blame]

373

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

Bu Sun Kim

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

[diff] [blame]

374

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

Bu Sun Kim

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

[diff] [blame]

375

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

382

383

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

Bu Sun Kim

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

[diff] [blame^]

384

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

385

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

386

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

387

# INVALID_ARGUMENT error.

388

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.

389

# Next id: 12

390

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

391

# execution state reaches "FINISHED".

392

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

393

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

394

# Defines an error trace message for a ScanRun.

395

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

396

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

397

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

398

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

399

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

400

# message encountered during scan configuration validation that is performed

401

# before each scan run.

402

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

403

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

404

# configuration error.

405

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

406

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

407

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

408

# future.

409

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

410

},

Bu Sun Kim

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

[diff] [blame]

411

},

Bu Sun Kim

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

[diff] [blame^]

412

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

413

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

414

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

415

# The ScanRun IDs are generated by the system.

416

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

417

{ # Output only.

418

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

419

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

420

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

421

},

422

],

423

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

424

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

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

# is either finished or stopped by user.

Bu Sun Kim

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

[diff] [blame]

437

},

Bu Sun Kim

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

[diff] [blame^]

438

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

439

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

440

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

441

# only.

442

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

443

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

444

"A String",

Bu Sun Kim

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

[diff] [blame]

445

],

Bu Sun Kim

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

[diff] [blame^]

446

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE

447

# will be used as a default.

448

"A String",

449

],

450

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

451

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

452

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

453

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

454

# immediately.

455

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

Bu Sun Kim

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

[diff] [blame]

456

},

Bu Sun Kim

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

[diff] [blame^]

457

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

458

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

459

# generated by the system.

460

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

461

# Command Center.

462

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

463

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

464

"A String",

465

],

466

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

467

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

468

# authentication configuration during scanning.

469

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

470

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

471

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

472

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

473

},

474

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

475

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

476

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

477

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

478

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by

479

# Identity-Aware-Proxy(IAP).

480

},

481

},

482

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

483

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

484

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

485

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

486

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

487

},

488

},

489

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

490

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

494

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

Bu Sun Kim

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

[diff] [blame]

495

<pre>Lists ScanConfigs under a given project.

496

497

Args:

Dan O'Meara

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

[diff] [blame]

498

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

Bu Sun Kim

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

[diff] [blame]

499

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

Bu Sun Kim

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

[diff] [blame]

500

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

501

`next_page_token` value returned from a previous List request.

502

If unspecified, the first page of results is returned.

Bu Sun Kim

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

[diff] [blame]

503

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

504

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

505

reasonable value.

Bu Sun Kim

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

[diff] [blame]

506

x__xgafv: string, V1 error format.

507

Allowed values

508

1 - v1 error format

509

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

510

511

Returns:

512

An object of the form:

513

514

{ # Response for the `ListScanConfigs` method.

Bu Sun Kim

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

[diff] [blame]

515

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

Bu Sun Kim

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

[diff] [blame]

516

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

Bu Sun Kim

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

[diff] [blame^]

517

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

518

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

519

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

520

# INVALID_ARGUMENT error.

521

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.

522

# Next id: 12

523

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

524

# execution state reaches "FINISHED".

525

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

526

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

527

# Defines an error trace message for a ScanRun.

528

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

529

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

530

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

531

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

532

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

533

# message encountered during scan configuration validation that is performed

534

# before each scan run.

535

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

536

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

537

# configuration error.

538

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

539

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

540

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

541

# future.

542

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

543

},

Bu Sun Kim

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

[diff] [blame]

544

},

Bu Sun Kim

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

[diff] [blame^]

545

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

546

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

547

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

548

# The ScanRun IDs are generated by the system.

549

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

550

{ # Output only.

551

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

552

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

553

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

554

},

555

],

556

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

557

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

558

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

559

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

560

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

561

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

562

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

563

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

564

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

565

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

566

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

567

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

568

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

569

# is either finished or stopped by user.

Bu Sun Kim

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

[diff] [blame]

570

},

Bu Sun Kim

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

[diff] [blame^]

571

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

572

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

573

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

574

# only.

575

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

576

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

577

"A String",

Bu Sun Kim

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

[diff] [blame]

578

],

Bu Sun Kim

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

[diff] [blame^]

579

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE

580

# will be used as a default.

581

"A String",

582

],

583

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

584

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

585

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

586

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

587

# immediately.

588

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

Bu Sun Kim

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

[diff] [blame]

589

},

Bu Sun Kim

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

[diff] [blame^]

590

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

591

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

592

# generated by the system.

593

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

594

# Command Center.

595

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

596

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

597

"A String",

598

],

599

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

600

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

601

# authentication configuration during scanning.

602

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

603

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

604

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

605

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

606

},

607

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

608

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

609

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

610

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

611

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by

612

# Identity-Aware-Proxy(IAP).

613

},

614

},

615

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

616

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

617

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

618

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

619

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

620

},

621

},

622

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

Bu Sun Kim

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

[diff] [blame]

623

},

Bu Sun Kim

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

[diff] [blame]

624

],

Bu Sun Kim

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

[diff] [blame^]

625

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

626

# more results in the list.

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>

632

<pre>Retrieves the next page of results.

633

634

Args:

635

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

636

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

637

638

Returns:

Bu Sun Kim

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

[diff] [blame]

639

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]

640

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]

645

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

Bu Sun Kim

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

[diff] [blame]

646

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

647

648

Args:

649

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

Bu Sun Kim

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

[diff] [blame]

650

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

Bu Sun Kim

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

[diff] [blame]

651

generated by the system. (required)

Dan O'Meara

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

[diff] [blame]

652

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

653

The object takes the form of:

654

655

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

Bu Sun Kim

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

[diff] [blame^]

656

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

657

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

658

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

659

# INVALID_ARGUMENT error.

660

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.

661

# Next id: 12

662

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

663

# execution state reaches "FINISHED".

664

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

665

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

666

# Defines an error trace message for a ScanRun.

667

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

668

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

669

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

670

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

671

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

672

# message encountered during scan configuration validation that is performed

673

# before each scan run.

674

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

675

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

676

# configuration error.

677

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

678

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

679

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

680

# future.

681

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

682

},

Bu Sun Kim

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

[diff] [blame]

683

},

Bu Sun Kim

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

[diff] [blame^]

684

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

685

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

686

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

687

# The ScanRun IDs are generated by the system.

688

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

689

{ # Output only.

690

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

691

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

692

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

693

},

694

],

695

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

696

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

697

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

698

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

699

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

700

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

701

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

702

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

703

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

704

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

705

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

706

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

707

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

708

# is either finished or stopped by user.

Bu Sun Kim

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

[diff] [blame]

709

},

Bu Sun Kim

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

[diff] [blame^]

710

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

711

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

Bu Sun Kim

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

[diff] [blame]

712

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

713

# only.

Bu Sun Kim

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

[diff] [blame^]

714

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

715

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

716

"A String",

717

],

718

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE

719

# will be used as a default.

720

"A String",

721

],

Bu Sun Kim

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

[diff] [blame]

722

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

Bu Sun Kim

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

[diff] [blame]

723

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

724

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

725

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

726

# immediately.

Bu Sun Kim

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

[diff] [blame^]

727

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

Bu Sun Kim

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

[diff] [blame]

728

},

Bu Sun Kim

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

[diff] [blame^]

729

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

730

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

731

# generated by the system.

732

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

733

# Command Center.

734

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

735

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

736

"A String",

737

],

738

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

Bu Sun Kim

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

[diff] [blame]

739

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

740

# authentication configuration during scanning.

741

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

742

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

743

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

744

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

745

},

746

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

747

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

748

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

749

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

750

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by

751

# Identity-Aware-Proxy(IAP).

752

},

753

},

754

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

755

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

756

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

757

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

758

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

759

},

760

},

Bu Sun Kim

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

[diff] [blame^]

761

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

762

}

763

764

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

765

see

766

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

767

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

774

775

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

776

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

777

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

778

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

779

# INVALID_ARGUMENT error.

780

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.

781

# Next id: 12

782

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

783

# execution state reaches "FINISHED".

784

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

785

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

786

# Defines an error trace message for a ScanRun.

787

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

788

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

789

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

790

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

791

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

792

# message encountered during scan configuration validation that is performed

793

# before each scan run.

794

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

795

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

796

# configuration error.

797

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

798

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

799

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

800

# future.

801

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

802

},

Bu Sun Kim

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

[diff] [blame]

803

},

Bu Sun Kim

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

[diff] [blame^]

804

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

805

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

806

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

807

# The ScanRun IDs are generated by the system.

808

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

809

{ # Output only.

810

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

811

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

812

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

813

},

814

],

815

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

816

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

817

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

818

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

819

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

820

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

821

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

822

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

823

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

824

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

825

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

826

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

827

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

828

# is either finished or stopped by user.

Bu Sun Kim

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

[diff] [blame]

829

},

Bu Sun Kim

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

[diff] [blame^]

830

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

831

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

832

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

833

# only.

834

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

835

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

836

"A String",

837

],

838

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE

839

# will be used as a default.

840

"A String",

841

],

842

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

843

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

844

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

845

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

846

# immediately.

847

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

848

},

849

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

850

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

851

# generated by the system.

852

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

853

# Command Center.

854

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

855

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

856

"A String",

857

],

858

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

859

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

860

# authentication configuration during scanning.

861

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

862

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

863

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

864

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

865

},

866

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

867

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

868

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

869

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

870

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by

871

# Identity-Aware-Proxy(IAP).

872

},

873

},

874

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

875

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

876

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

877

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

878

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

879

},

880

},

881

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

882

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

887

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

888

889

Args:

Dan O'Meara

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

[diff] [blame]

890

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

Bu Sun Kim

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

[diff] [blame]

891

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

Bu Sun Kim

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

[diff] [blame]

892

body: object, The request body.

893

The object takes the form of:

894

895

{ # Request for the `StartScanRun` method.

896

}

897

898

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

905

906

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

907

# Next id: 12

Bu Sun Kim

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

[diff] [blame]

908

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

909

# execution state reaches "FINISHED".

Bu Sun Kim

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

[diff] [blame]

910

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

911

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

Bu Sun Kim

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

[diff] [blame]

912

# Defines an error trace message for a ScanRun.

Bu Sun Kim

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

[diff] [blame^]

913

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

914

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

915

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

916

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

Bu Sun Kim

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

[diff] [blame]

917

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

Bu Sun Kim

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

[diff] [blame]

918

# message encountered during scan configuration validation that is performed

919

# before each scan run.

920

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

921

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

922

# configuration error.

Bu Sun Kim

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

[diff] [blame]

923

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

924

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

Bu Sun Kim

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

[diff] [blame]

925

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

926

# future.

Bu Sun Kim

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

[diff] [blame]

927

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

Bu Sun Kim

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

[diff] [blame]

928

},

929

},

Bu Sun Kim

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

[diff] [blame^]

930

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

931

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

932

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

933

# The ScanRun IDs are generated by the system.

934

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

935

{ # Output only.

936

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

937

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

938

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

939

},

940

],

941

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

942

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

943

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

944

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

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

# is either finished or stopped by user.

Bu Sun Kim