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

Dan O'Meara

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

[diff] [blame]

92

<code><a href="#list">list(parent, pageSize=None, pageToken=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-05-20 12:08:20 -0700

[diff] [blame^]

115

"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be

Bu Sun Kim

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

[diff] [blame]

116

# used as a default.

Bu Sun Kim

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

[diff] [blame^]

117

"A String",

Bu Sun Kim

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

[diff] [blame]

118

],

Bu Sun Kim

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

[diff] [blame^]

119

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

120

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

121

# generated by the system.

122

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

123

# Command Center.

124

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

Bu Sun Kim

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

[diff] [blame]

125

# Next id: 12

Bu Sun Kim

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

[diff] [blame^]

126

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

127

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

128

# is either finished or stopped by user.

129

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

130

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

131

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

132

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

133

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

Bu Sun Kim

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

[diff] [blame]

134

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

135

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

136

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

Bu Sun Kim

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

[diff] [blame^]

137

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

138

{ # Output only.

139

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

140

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

141

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

142

},

143

],

144

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

145

# execution state reaches "FINISHED".

146

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

147

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

148

# The ScanRun IDs are generated by the system.

149

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

150

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

Bu Sun Kim

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

[diff] [blame]

151

# Defines an error trace message for a ScanRun.

Bu Sun Kim

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

[diff] [blame^]

152

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

153

# message encountered during scan configuration validation that is performed

154

# before each scan run.

155

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

156

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

157

# configuration error.

Bu Sun Kim

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

[diff] [blame^]

158

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

159

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

Bu Sun Kim

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

[diff] [blame]

160

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

161

# future.

Bu Sun Kim

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

[diff] [blame^]

162

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

163

},

164

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

165

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

166

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

167

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

168

},

169

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

170

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

171

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

172

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

173

},

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

# immediately.

182

},

183

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

184

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

185

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

186

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

187

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

188

# INVALID_ARGUMENT error.

189

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

190

# authentication configuration during scanning.

191

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

192

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

193

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

194

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

195

},

196

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

197

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

198

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

199

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

200

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

201

},

202

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

203

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

204

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

205

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

206

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

207

# Identity-Aware-Proxy(IAP).

Bu Sun Kim

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

[diff] [blame]

208

},

209

},

Bu Sun Kim

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

[diff] [blame]

210

},

Bu Sun Kim

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

[diff] [blame^]

211

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

212

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

213

# only.

214

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

215

# https://cloud.google.com/security-scanner/docs/excluded-urls

216

"A String",

217

],

218

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

219

"A String",

220

],

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame^]

232

"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be

Bu Sun Kim

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

[diff] [blame]

233

# used as a default.

Bu Sun Kim

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

[diff] [blame^]

234

"A String",

Bu Sun Kim

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

[diff] [blame]

235

],

Bu Sun Kim

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

[diff] [blame^]

236

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

237

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

238

# generated by the system.

239

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

240

# Command Center.

241

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

Bu Sun Kim

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

[diff] [blame]

242

# Next id: 12

Bu Sun Kim

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

[diff] [blame^]

243

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

244

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

245

# is either finished or stopped by user.

246

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

247

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

248

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

249

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

250

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

Bu Sun Kim

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

[diff] [blame]

251

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

252

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

253

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

Bu Sun Kim

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

[diff] [blame^]

254

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

255

{ # Output only.

256

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

257

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

258

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

259

},

260

],

261

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

262

# execution state reaches "FINISHED".

263

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

264

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

265

# The ScanRun IDs are generated by the system.

266

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

267

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

Bu Sun Kim

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

[diff] [blame]

268

# Defines an error trace message for a ScanRun.

Bu Sun Kim

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

[diff] [blame^]

269

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

270

# message encountered during scan configuration validation that is performed

271

# before each scan run.

272

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

273

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

274

# configuration error.

Bu Sun Kim

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

[diff] [blame^]

275

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

276

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

Bu Sun Kim

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

[diff] [blame]

277

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

278

# future.

Bu Sun Kim

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

[diff] [blame^]

279

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

280

},

281

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

282

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

283

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

284

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

285

},

286

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

287

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

288

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

289

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

290

},

291

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

292

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

293

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

294

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

295

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

296

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

297

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

298

# immediately.

299

},

300

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

301

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

302

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

303

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

304

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

305

# INVALID_ARGUMENT error.

306

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

307

# authentication configuration during scanning.

308

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

309

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

310

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

311

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

312

},

313

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

314

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

315

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

316

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

317

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

318

},

319

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

320

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

321

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

322

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

323

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

324

# Identity-Aware-Proxy(IAP).

Bu Sun Kim

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

[diff] [blame]

325

},

326

},

Bu Sun Kim

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

[diff] [blame]

327

},

Bu Sun Kim

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

[diff] [blame^]

328

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

329

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

330

# only.

331

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

332

# https://cloud.google.com/security-scanner/docs/excluded-urls

333

"A String",

334

],

335

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

336

"A String",

337

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

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

[diff] [blame^]

384

"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be

Bu Sun Kim

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

[diff] [blame]

385

# used as a default.

Bu Sun Kim

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

[diff] [blame^]

386

"A String",

Bu Sun Kim

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

[diff] [blame]

387

],

Bu Sun Kim

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

[diff] [blame^]

388

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

389

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

390

# generated by the system.

391

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

392

# Command Center.

393

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

Bu Sun Kim

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

[diff] [blame]

394

# Next id: 12

Bu Sun Kim

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

[diff] [blame^]

395

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

396

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

397

# is either finished or stopped by user.

398

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

399

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

400

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

401

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

402

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

Bu Sun Kim

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

[diff] [blame]

403

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

404

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

405

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

Bu Sun Kim

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

[diff] [blame^]

406

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

407

{ # Output only.

408

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

409

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

410

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

411

},

412

],

413

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

414

# execution state reaches "FINISHED".

415

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

416

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

417

# The ScanRun IDs are generated by the system.

418

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

419

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

Bu Sun Kim

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

[diff] [blame]

420

# Defines an error trace message for a ScanRun.

Bu Sun Kim

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

[diff] [blame^]

421

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

422

# message encountered during scan configuration validation that is performed

423

# before each scan run.

424

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

425

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

426

# configuration error.

Bu Sun Kim

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

[diff] [blame^]

427

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

428

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

Bu Sun Kim

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

[diff] [blame]

429

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

430

# future.

Bu Sun Kim

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

[diff] [blame^]

431

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

432

},

433

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

434

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

435

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

436

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

437

},

438

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

439

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

440

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

441

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

442

},

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

# immediately.

451

},

452

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

453

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

454

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

455

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

456

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

457

# INVALID_ARGUMENT error.

458

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

459

# authentication configuration during scanning.

460

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

461

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

462

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

463

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

464

},

465

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

466

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

467

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

468

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

469

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

470

},

471

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

472

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

473

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

474

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

475

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

476

# Identity-Aware-Proxy(IAP).

Bu Sun Kim

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

[diff] [blame]

477

},

478

},

Bu Sun Kim

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

[diff] [blame]

479

},

Bu Sun Kim

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

[diff] [blame^]

480

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

481

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

482

# only.

483

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

484

# https://cloud.google.com/security-scanner/docs/excluded-urls

485

"A String",

486

],

487

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

488

"A String",

489

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

494

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

Dan O'Meara

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

[diff] [blame]

500

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

501

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

502

reasonable value.

Bu Sun Kim

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

[diff] [blame]

503

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

504

`next_page_token` value returned from a previous List request.

505

If unspecified, the first page of results is returned.

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

[diff] [blame^]

517

"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be

Bu Sun Kim

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

[diff] [blame]

518

# used as a default.

Bu Sun Kim

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

[diff] [blame^]

519

"A String",

Bu Sun Kim

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

[diff] [blame]

520

],

Bu Sun Kim

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

[diff] [blame^]

521

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

522

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

523

# generated by the system.

524

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

525

# Command Center.

526

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

Bu Sun Kim

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

[diff] [blame]

527

# Next id: 12

Bu Sun Kim

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

[diff] [blame^]

528

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

529

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

530

# is either finished or stopped by user.

531

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

532

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

533

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

534

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

535

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

Bu Sun Kim

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

[diff] [blame]

536

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

537

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

538

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

Bu Sun Kim

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

[diff] [blame^]

539

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

540

{ # Output only.

541

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

542

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

543

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

544

},

545

],

546

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

547

# execution state reaches "FINISHED".

548

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

549

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

550

# The ScanRun IDs are generated by the system.

551

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

552

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

Bu Sun Kim

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

[diff] [blame]

553

# Defines an error trace message for a ScanRun.

Bu Sun Kim

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

[diff] [blame^]

554

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

555

# message encountered during scan configuration validation that is performed

556

# before each scan run.

557

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

558

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

559

# configuration error.

Bu Sun Kim

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

[diff] [blame^]

560

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

561

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

Bu Sun Kim

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

[diff] [blame]

562

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

563

# future.

Bu Sun Kim

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

[diff] [blame^]

564

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

565

},

566

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

567

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

568

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

569

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

570

},

571

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

572

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

573

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

574

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

575

},

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

# immediately.

584

},

585

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

586

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

587

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

588

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

589

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

590

# INVALID_ARGUMENT error.

591

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

592

# authentication configuration during scanning.

593

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

594

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

595

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

596

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

597

},

598

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

599

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

600

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

601

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

602

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

603

},

604

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

605

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

606

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

607

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

608

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

609

# Identity-Aware-Proxy(IAP).

Bu Sun Kim

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

[diff] [blame]

610

},

611

},

Bu Sun Kim

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

[diff] [blame]

612

},

Bu Sun Kim

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

[diff] [blame^]

613

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

614

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

615

# only.

616

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

617

# https://cloud.google.com/security-scanner/docs/excluded-urls

618

"A String",

619

],

620

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

621

"A String",

622

],

Bu Sun Kim

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

[diff] [blame]

623

},

624

],

Bu Sun Kim

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

[diff] [blame^]

656

"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be

Bu Sun Kim

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

[diff] [blame]

657

# used as a default.

Bu Sun Kim

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

[diff] [blame^]

658

"A String",

Bu Sun Kim

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

[diff] [blame]

659

],

Bu Sun Kim

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

[diff] [blame^]

660

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

661

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

662

# generated by the system.

663

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

664

# Command Center.

665

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

Bu Sun Kim

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

[diff] [blame]

666

# Next id: 12

Bu Sun Kim

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

[diff] [blame^]

667

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

668

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

669

# is either finished or stopped by user.

670

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

671

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

672

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

673

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

674

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

Bu Sun Kim

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

[diff] [blame]

675

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

676

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

677

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

Bu Sun Kim

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

[diff] [blame^]

678

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

679

{ # Output only.

680

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

681

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

682

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

683

},

684

],

685

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

686

# execution state reaches "FINISHED".

687

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

688

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

689

# The ScanRun IDs are generated by the system.

690

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

691

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

Bu Sun Kim

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

[diff] [blame]

692

# Defines an error trace message for a ScanRun.

Bu Sun Kim

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

[diff] [blame^]

693

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

694

# message encountered during scan configuration validation that is performed

695

# before each scan run.

696

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

697

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

698

# configuration error.

Bu Sun Kim

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

[diff] [blame^]

699

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

700

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

Bu Sun Kim

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

[diff] [blame]

701

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

702

# future.

Bu Sun Kim

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

[diff] [blame^]

703

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

704

},

705

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

706

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

707

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

708

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

709

},

710

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

711

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

712

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

713

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

714

},

715

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

716

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

717

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

718

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

719

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

720

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

721

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

722

# immediately.

723

},

724

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

725

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

726

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

727

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

728

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

729

# INVALID_ARGUMENT error.

730

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

731

# authentication configuration during scanning.

732

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

733

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

734

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

735

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

736

},

737

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

738

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

739

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

740

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

741

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

742

},

743

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

744

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

745

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

746

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

747

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

748

# Identity-Aware-Proxy(IAP).

Bu Sun Kim

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

[diff] [blame]

749

},

750

},

Bu Sun Kim

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

[diff] [blame]

751

},

Bu Sun Kim

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

[diff] [blame^]

752

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

753

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

754

# only.

755

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

756

# https://cloud.google.com/security-scanner/docs/excluded-urls

757

"A String",

758

],

759

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

760

"A String",

761

],

Bu Sun Kim

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

[diff] [blame]

762

}

763

Dan O'Meara

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

[diff] [blame]

764

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

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame^]

776

"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be

Bu Sun Kim

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

[diff] [blame]

777

# used as a default.

Bu Sun Kim

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

[diff] [blame^]

778

"A String",

Bu Sun Kim

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

[diff] [blame]

779

],

Bu Sun Kim

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

[diff] [blame^]

780

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

781

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

782

# generated by the system.

783

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

784

# Command Center.

785

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

Bu Sun Kim

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

[diff] [blame]

786

# Next id: 12

Bu Sun Kim

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

[diff] [blame^]

787

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

788

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

789

# is either finished or stopped by user.

790

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

791

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

792

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

793

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

794

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

Bu Sun Kim

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

[diff] [blame]

795

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

796

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

797

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

Bu Sun Kim

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

[diff] [blame^]

798

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

799

{ # Output only.

800

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

801

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

802

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

803

},

804

],

805

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

806

# execution state reaches "FINISHED".

807

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

808

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

809

# The ScanRun IDs are generated by the system.

810

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

811

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

Bu Sun Kim

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

[diff] [blame]

812

# Defines an error trace message for a ScanRun.

Bu Sun Kim

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

[diff] [blame^]

813

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

814

# message encountered during scan configuration validation that is performed

815

# before each scan run.

816

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

817

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

818

# configuration error.

Bu Sun Kim

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

[diff] [blame^]

819

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

820

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

Bu Sun Kim

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

[diff] [blame]

821

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

822

# future.

Bu Sun Kim

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

[diff] [blame^]

823

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

824

},

825

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

826

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

827

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

828

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

829

},

830

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

831

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

832

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

833

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

834

},

835

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

836

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

837

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

838

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

839

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

840

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

841

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

842

# immediately.

843

},

844

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

845

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

846

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

847

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

848

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

849

# INVALID_ARGUMENT error.

850

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

851

# authentication configuration during scanning.

852

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

853

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

854

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

855

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

856

},

857

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

858

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

859

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

860

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

861

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

862

},

863

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

864

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

865

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

866

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

867

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

868

# Identity-Aware-Proxy(IAP).

Bu Sun Kim

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

[diff] [blame]

869

},

870

},

Bu Sun Kim

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

[diff] [blame]

871

},

Bu Sun Kim

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

[diff] [blame^]

872

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

873

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

874

# only.

875

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

876

# https://cloud.google.com/security-scanner/docs/excluded-urls

877

"A String",

878

],

879

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

880

"A String",

881

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

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

[diff] [blame^]

908

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

909

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

910

# is either finished or stopped by user.

911

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

912

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

913

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

914

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

915

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

Bu Sun Kim

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

[diff] [blame]

916

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

917

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

918

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

Bu Sun Kim

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

[diff] [blame^]

919

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

920

{ # Output only.

921

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

922

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

923

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

924

},

925

],

926

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

927

# execution state reaches "FINISHED".

928

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

929

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

930

# The ScanRun IDs are generated by the system.

931

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

932

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

Bu Sun Kim

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

[diff] [blame]

933

# Defines an error trace message for a ScanRun.

Bu Sun Kim

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

[diff] [blame^]

934

"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