Blame - docs/dyn/websecurityscanner_v1alpha.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-20 12:08:20 -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-05-20 12:08:20 -0700

[diff] [blame]

115

# next id: 12

Bu Sun Kim

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

[diff] [blame]

116

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

Bu Sun Kim

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

[diff] [blame]

117

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

118

"A String",

119

],

Bu Sun Kim

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

[diff] [blame]

120

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

Bu Sun Kim

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

[diff] [blame]

121

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

122

# authentication configuration during scanning.

123

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

124

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

125

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

126

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

127

},

128

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

Bu Sun Kim

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

[diff] [blame]

129

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

Bu Sun Kim

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

[diff] [blame]

130

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

131

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

Bu Sun Kim

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

[diff] [blame]

132

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

133

},

134

},

Bu Sun Kim

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

[diff] [blame]

135

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

136

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

137

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

138

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

139

# execution state reaches "FINISHED".

140

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

141

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

142

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

143

# The ScanRun IDs are generated by the system.

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

# is either finished or stopped by user.

156

},

157

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

158

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

159

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

160

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

161

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

162

# immediately.

163

},

164

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

165

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

166

"A String",

167

],

168

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

169

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

170

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

171

# INVALID_ARGUMENT error.

172

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

173

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

174

# generated by the system.

175

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

176

# will be used as a default.

177

"A String",

178

],

Bu Sun Kim

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

[diff] [blame]

179

}

Bu Sun Kim

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

[diff] [blame]

180

181

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

188

189

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

Bu Sun Kim

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

[diff] [blame]

190

# next id: 12

Bu Sun Kim

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

[diff] [blame]

191

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

Bu Sun Kim

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

[diff] [blame]

192

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

193

"A String",

194

],

Bu Sun Kim

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

[diff] [blame]

195

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

Bu Sun Kim

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

[diff] [blame]

196

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

197

# authentication configuration during scanning.

198

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

199

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

200

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

201

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

202

},

203

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

Bu Sun Kim

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

[diff] [blame]

204

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

Bu Sun Kim

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

[diff] [blame]

205

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

206

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

Bu Sun Kim

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

[diff] [blame]

207

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

208

},

209

},

Bu Sun Kim

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

[diff] [blame]

210

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

211

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

212

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

213

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

214

# execution state reaches "FINISHED".

215

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

216

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

217

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

218

# The ScanRun IDs are generated by the system.

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

230

# is either finished or stopped by user.

231

},

232

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

233

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

234

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

235

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

236

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

237

# immediately.

238

},

239

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

240

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

241

"A String",

242

],

243

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

244

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

245

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

246

# INVALID_ARGUMENT error.

247

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

248

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

249

# generated by the system.

250

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

251

# will be used as a default.

252

"A String",

253

],

Bu Sun Kim

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

[diff] [blame]

254

}</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>

259

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

260

261

Args:

Dan O'Meara

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

[diff] [blame]

262

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]

263

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

Bu Sun Kim

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

[diff] [blame]

264

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

271

272

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

273

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

274

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

275

#

276

# service Foo {

277

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

278

# }

279

#

280

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

}</pre>

</div>

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

286

<pre>Gets a ScanConfig.

287

288

Args:

Dan O'Meara

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

[diff] [blame]

289

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]

290

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

Bu Sun Kim

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

[diff] [blame]

291

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

298

299

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

Bu Sun Kim

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

[diff] [blame]

300

# next id: 12

Bu Sun Kim

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

[diff] [blame]

301

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

Bu Sun Kim

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

[diff] [blame]

302

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

303

"A String",

304

],

Bu Sun Kim

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

[diff] [blame]

305

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

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

314

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

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

317

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

318

},

319

},

Bu Sun Kim

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

[diff] [blame]

320

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

321

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

322

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

323

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

324

# execution state reaches "FINISHED".

325

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

326

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

327

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

328

# The ScanRun IDs are generated by the system.

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

# is either finished or stopped by user.

341

},

342

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

343

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

344

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

345

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

346

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

347

# immediately.

348

},

349

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

350

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

351

"A String",

352

],

353

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

354

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

355

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

356

# INVALID_ARGUMENT error.

357

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

358

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

359

# generated by the system.

360

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

361

# will be used as a default.

362

"A String",

363

],

Bu Sun Kim

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

[diff] [blame]

364

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

368

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

369

<pre>Lists ScanConfigs under a given project.

370

371

Args:

Dan O'Meara

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

[diff] [blame]

372

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]

373

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

Bu Sun Kim

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

[diff] [blame]

374

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

375

`next_page_token` value returned from a previous List request.

376

If unspecified, the first page of results is returned.

Bu Sun Kim

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

[diff] [blame]

377

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

378

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

379

reasonable value.

Bu Sun Kim

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

[diff] [blame]

380

x__xgafv: string, V1 error format.

381

Allowed values

382

1 - v1 error format

383

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

384

385

Returns:

386

An object of the form:

387

388

{ # Response for the `ListScanConfigs` method.

Bu Sun Kim

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

[diff] [blame]

389

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

390

# more results in the list.

Bu Sun Kim

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

[diff] [blame]

391

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

Bu Sun Kim

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

[diff] [blame]

392

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

Bu Sun Kim

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

[diff] [blame]

393

# next id: 12

Bu Sun Kim

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

[diff] [blame]

394

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

Bu Sun Kim

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

[diff] [blame]

395

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

396

"A String",

397

],

Bu Sun Kim

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

[diff] [blame]

398

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

Bu Sun Kim

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

[diff] [blame]

399

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

400

# authentication configuration during scanning.

401

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

402

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

403

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

404

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

405

},

406

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

Bu Sun Kim

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

[diff] [blame]

407

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

Bu Sun Kim

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

[diff] [blame]

408

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

409

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

Bu Sun Kim

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

[diff] [blame]

410

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

411

},

Bu Sun Kim

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

[diff] [blame]

412

},

Bu Sun Kim

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

[diff] [blame]

413

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

414

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

415

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

416

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

417

# execution state reaches "FINISHED".

418

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

419

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

420

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

421

# The ScanRun IDs are generated by the system.

422

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

423

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

424

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

425

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

426

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

427

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

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

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

433

# is either finished or stopped by user.

434

},

435

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

436

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

437

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

438

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

439

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

440

# immediately.

441

},

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

445

],

446

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

447

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

448

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

449

# INVALID_ARGUMENT error.

450

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

451

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

452

# generated by the system.

453

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

454

# will be used as a default.

455

"A String",

456

],

Bu Sun Kim

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

[diff] [blame]

457

},

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>

464

<pre>Retrieves the next page of results.

465

466

Args:

467

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

468

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

469

470

Returns:

Bu Sun Kim

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

[diff] [blame]

471

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]

472

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]

477

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

478

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

479

480

Args:

481

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]

482

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

Bu Sun Kim

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

[diff] [blame]

483

generated by the system. (required)

Dan O'Meara

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

[diff] [blame]

484

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

485

The object takes the form of:

486

487

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

Bu Sun Kim

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

[diff] [blame]

488

# next id: 12

Bu Sun Kim

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

[diff] [blame]

489

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

Bu Sun Kim

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

[diff] [blame]

490

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

491

"A String",

492

],

Bu Sun Kim

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

[diff] [blame]

493

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

Bu Sun Kim

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

[diff] [blame]

494

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

495

# authentication configuration during scanning.

496

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

497

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

498

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

499

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

500

},

501

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

Bu Sun Kim

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

[diff] [blame]

502

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

Bu Sun Kim

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

[diff] [blame]

503

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

504

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

Bu Sun Kim

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

[diff] [blame]

505

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

506

},

507

},

Bu Sun Kim

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

[diff] [blame]

508

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

509

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

510

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

511

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

512

# execution state reaches "FINISHED".

513

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

514

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

515

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

516

# The ScanRun IDs are generated by the system.

517

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

518

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

519

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

520

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

521

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

522

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

523

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

524

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

525

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

526

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

527

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

528

# is either finished or stopped by user.

529

},

530

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

531

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

532

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

533

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

534

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

535

# immediately.

536

},

537

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

538

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

539

"A String",

540

],

541

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

542

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

543

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

544

# INVALID_ARGUMENT error.

545

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

546

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

547

# generated by the system.

548

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

549

# will be used as a default.

550

"A String",

551

],

Bu Sun Kim

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

[diff] [blame]

552

}

Bu Sun Kim

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

[diff] [blame]

553

Dan O'Meara

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

[diff] [blame]

554

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]

555

see

556

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

557

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

564

565

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

Bu Sun Kim

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

[diff] [blame]

566

# next id: 12

Bu Sun Kim

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

[diff] [blame]

567

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

Bu Sun Kim

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

[diff] [blame]

568

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

569

"A String",

570

],

Bu Sun Kim

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

[diff] [blame]

571

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

Bu Sun Kim

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

[diff] [blame]

572

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

573

# authentication configuration during scanning.

574

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

575

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

576

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

577

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

578

},

579

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

Bu Sun Kim

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

[diff] [blame]

580

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

Bu Sun Kim

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

[diff] [blame]

581

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

582

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

Bu Sun Kim

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

[diff] [blame]

583

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

584

},

585

},

Bu Sun Kim

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

[diff] [blame]

586

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

587

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

588

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

589

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

590

# execution state reaches "FINISHED".

591

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

592

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

593

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

594

# The ScanRun IDs are generated by the system.

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

# is either finished or stopped by user.

607

},

608

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

609

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

610

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

611

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

612

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

613

# immediately.

614

},

615

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

616

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

617

"A String",

618

],

619

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

620

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

621

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

622

# INVALID_ARGUMENT error.

623

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

624

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

625

# generated by the system.

626

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

627

# will be used as a default.

628

"A String",

629

],

Bu Sun Kim

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

[diff] [blame]

630

}</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>

635

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

636

637

Args:

Dan O'Meara

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

[diff] [blame]

638

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]

639

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

Bu Sun Kim

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

[diff] [blame]

640

body: object, The request body.

641

The object takes the form of:

642

643

{ # Request for the `StartScanRun` method.

644

}

645

646

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

653

654

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

Bu Sun Kim

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

[diff] [blame]

655

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

656

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

657

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

658

# execution state reaches "FINISHED".

659

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

660

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

661

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

662

# The ScanRun IDs are generated by the system.

Bu Sun Kim

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

[diff] [blame]

663

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

Bu Sun Kim

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

[diff] [blame]

664

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

665

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

666

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

Bu Sun Kim

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

[diff] [blame]

667

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

668

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

Bu Sun Kim

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

[diff] [blame]

669

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

670

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

671

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

672

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

Bu Sun Kim

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

[diff] [blame]

673

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

674

# is either finished or stopped by user.

Bu Sun Kim