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

# next id: 12

Bu Sun Kim

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

[diff] [blame]

116

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

Bu Sun Kim

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

[diff] [blame]

117

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

118

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

119

# generated by the system.

Bu Sun Kim

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

[diff] [blame]

120

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

121

# authentication configuration during scanning.

Bu Sun Kim

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

[diff] [blame]

122

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

123

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

124

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

125

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

126

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

127

},

Bu Sun Kim

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

[diff] [blame]

128

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

129

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

130

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

131

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

132

},

Bu Sun Kim

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

[diff] [blame]

133

},

Bu Sun Kim

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

[diff] [blame]

134

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

135

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

136

"A String",

137

],

138

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

139

# will be used as a default.

140

"A String",

141

],

Bu Sun Kim

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

[diff] [blame]

142

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

Bu Sun Kim

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

[diff] [blame]

143

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

144

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

145

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

146

# immediately.

Bu Sun Kim

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

[diff] [blame]

147

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

Bu Sun Kim

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

[diff] [blame]

148

},

Bu Sun Kim

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

[diff] [blame]

149

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

150

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

151

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

152

# INVALID_ARGUMENT error.

Bu Sun Kim

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

[diff] [blame]

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

# is either finished or stopped by user.

165

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

166

# execution state reaches "FINISHED".

167

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

168

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

169

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

170

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

171

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

172

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

173

# The ScanRun IDs are generated by the system.

174

},

175

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

176

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

Bu Sun Kim

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

[diff] [blame]

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

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

Bu Sun Kim

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

[diff] [blame]

192

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

193

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

194

# generated by the system.

Bu Sun Kim

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

[diff] [blame]

195

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

196

# authentication configuration during scanning.

Bu Sun Kim

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

[diff] [blame]

197

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

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

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

201

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

202

},

Bu Sun Kim

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

[diff] [blame]

203

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

204

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

205

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

206

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

207

},

Bu Sun Kim

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

[diff] [blame]

208

},

Bu Sun Kim

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

[diff] [blame]

209

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

210

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

211

"A String",

212

],

213

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

214

# will be used as a default.

215

"A String",

216

],

Bu Sun Kim

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

[diff] [blame]

217

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

Bu Sun Kim

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

[diff] [blame]

218

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

219

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

220

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

221

# immediately.

Bu Sun Kim

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

[diff] [blame]

222

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

Bu Sun Kim

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

[diff] [blame]

223

},

Bu Sun Kim

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

[diff] [blame]

224

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

225

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

226

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

227

# INVALID_ARGUMENT error.

Bu Sun Kim

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

[diff] [blame]

228

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

229

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

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

# is either finished or stopped by user.

240

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

241

# execution state reaches "FINISHED".

242

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

243

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

244

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

245

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

246

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

247

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

248

# The ScanRun IDs are generated by the system.

249

},

250

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

251

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

Bu Sun Kim

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

[diff] [blame]

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

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

Bu Sun Kim

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

[diff] [blame]

302

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

303

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

304

# generated by the system.

Bu Sun Kim

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

[diff] [blame]

305

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

306

# authentication configuration during scanning.

Bu Sun Kim

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

[diff] [blame]

307

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

308

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

309

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

310

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

311

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

312

},

Bu Sun Kim

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

[diff] [blame]

313

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

314

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

315

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

316

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

317

},

Bu Sun Kim

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

[diff] [blame]

318

},

Bu Sun Kim

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

[diff] [blame]

319

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

320

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

321

"A String",

322

],

323

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

324

# will be used as a default.

325

"A String",

326

],

Bu Sun Kim

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

[diff] [blame]

327

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

Bu Sun Kim

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

[diff] [blame]

328

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

329

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

330

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

331

# immediately.

Bu Sun Kim

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

[diff] [blame]

332

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

Bu Sun Kim

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

[diff] [blame]

333

},

Bu Sun Kim

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

[diff] [blame]

334

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

335

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

336

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

337

# INVALID_ARGUMENT error.

Bu Sun Kim

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

[diff] [blame]

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

# is either finished or stopped by user.

350

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

351

# execution state reaches "FINISHED".

352

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

353

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

354

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

355

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

356

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

357

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

358

# The ScanRun IDs are generated by the system.

359

},

360

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

361

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

Bu Sun Kim

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

[diff] [blame]

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

[diff] [blame]

368

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

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

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

[diff] [blame]

374

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

375

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

376

reasonable value.

Bu Sun Kim

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

[diff] [blame]

377

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

378

`next_page_token` value returned from a previous List request.

379

If unspecified, the first page of results is returned.

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

[diff] [blame]

389

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

Bu Sun Kim

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

[diff] [blame]

390

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

Bu Sun Kim

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

[diff] [blame]

391

# next id: 12

Bu Sun Kim

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

[diff] [blame]

392

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

Bu Sun Kim

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

[diff] [blame]

393

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

394

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

395

# generated by the system.

Bu Sun Kim

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

[diff] [blame]

396

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

397

# authentication configuration during scanning.

Bu Sun Kim

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

[diff] [blame]

398

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

399

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

400

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

401

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

402

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

403

},

Bu Sun Kim

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

[diff] [blame]

404

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

405

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

406

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

407

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

408

},

Bu Sun Kim

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

[diff] [blame]

409

},

Bu Sun Kim

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

[diff] [blame]

410

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

411

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

412

"A String",

413

],

414

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

415

# will be used as a default.

416

"A String",

417

],

Bu Sun Kim

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

[diff] [blame]

418

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

Bu Sun Kim

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

[diff] [blame]

419

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

420

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

421

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

422

# immediately.

Bu Sun Kim

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

[diff] [blame]

423

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

424

},

425

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

426

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

427

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

428

# INVALID_ARGUMENT error.

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

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

438

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

439

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

440

# is either finished or stopped by user.

441

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

442

# execution state reaches "FINISHED".

443

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

444

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

445

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

446

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

447

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

448

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

449

# The ScanRun IDs are generated by the system.

Bu Sun Kim

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

[diff] [blame]

450

},

451

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

452

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

453

"A String",

454

],

Bu Sun Kim

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

[diff] [blame]

455

},

Bu Sun Kim

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

[diff] [blame]

456

],

Bu Sun Kim

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

[diff] [blame]

457

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

458

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

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

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

Bu Sun Kim

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

[diff] [blame]

490

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

491

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

492

# generated by the system.

Bu Sun Kim

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

[diff] [blame]

493

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

494

# authentication configuration during scanning.

Bu Sun Kim

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

[diff] [blame]

495

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

496

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

497

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

498

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

499

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

500

},

Bu Sun Kim

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

[diff] [blame]

501

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

502

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

503

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

504

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

505

},

Bu Sun Kim

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

[diff] [blame]

506

},

Bu Sun Kim

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

[diff] [blame]

507

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

508

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

509

"A String",

510

],

511

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

512

# will be used as a default.

513

"A String",

514

],

Bu Sun Kim

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

[diff] [blame]

515

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

Bu Sun Kim

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

[diff] [blame]

516

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

517

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

518

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

519

# immediately.

Bu Sun Kim

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

[diff] [blame]

520

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

Bu Sun Kim

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

[diff] [blame]

521

},

Bu Sun Kim

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

[diff] [blame]

522

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

523

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

524

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

525

# INVALID_ARGUMENT error.

Bu Sun Kim

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

[diff] [blame]

526

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

527

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

528

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

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

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

537

# is either finished or stopped by user.

538

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

539

# execution state reaches "FINISHED".

540

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

541

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

542

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

543

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

544

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

545

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

546

# The ScanRun IDs are generated by the system.

547

},

548

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

549

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

Bu Sun Kim

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

[diff] [blame]

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

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

Bu Sun Kim

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

[diff] [blame]

568

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

569

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

570

# generated by the system.

Bu Sun Kim

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

[diff] [blame]

571

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

572

# authentication configuration during scanning.

Bu Sun Kim

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

[diff] [blame]

573

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

574

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

575

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

576

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

577

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

578

},

Bu Sun Kim

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

[diff] [blame]

579

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

580

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

581

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

582

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

583

},

Bu Sun Kim

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

[diff] [blame]

584

},

Bu Sun Kim

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

[diff] [blame]

585

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

586

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

587

"A String",

588

],

589

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

590

# will be used as a default.

591

"A String",

592

],

Bu Sun Kim

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

[diff] [blame]

593

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

Bu Sun Kim

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

[diff] [blame]

594

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

595

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

596

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

597

# immediately.

Bu Sun Kim

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

[diff] [blame]

598

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

Bu Sun Kim

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

[diff] [blame]

599

},

Bu Sun Kim

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

[diff] [blame]

600

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

601

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

602

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

603

# INVALID_ARGUMENT error.

Bu Sun Kim

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

[diff] [blame]

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

# is either finished or stopped by user.

616

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

617

# execution state reaches "FINISHED".

618

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

619

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

620

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

621

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

622

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

623

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

624

# The ScanRun IDs are generated by the system.

625

},

626

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

627

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

Bu Sun Kim

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

[diff] [blame]

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

[diff] [blame]

655

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

656

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

Bu Sun Kim

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

[diff] [blame]

657

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

658

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

Bu Sun Kim

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

[diff] [blame]

659

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

660

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

661

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

662

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

Bu Sun Kim

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

[diff] [blame]

663

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

Bu Sun Kim

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

[diff] [blame]

664

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

665

# is either finished or stopped by user.

Bu Sun Kim

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

[diff] [blame]

666

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

667

# execution state reaches "FINISHED".

668

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

669

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

670

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

671

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

672

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

673

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

674

# The ScanRun IDs are generated by the system.

Bu Sun Kim