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

2020-10-06 16:46:05 -0700

[diff] [blame]

83

<code><a href="#close">close()</a></code></p>

84

<p class="firstline">Close httplib2 connections.</p>

85

Dan O'Meara

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

[diff] [blame]

86

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

87

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

88

89

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

90

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

91

92

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

93

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

94

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

95

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

96

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

97

98

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

99

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

100

Dan O'Meara

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

[diff] [blame]

101

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

102

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

103

104

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

105

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

106

<h3>Method Details</h3>

107

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

108

<code class="details" id="close">close()</code>

109

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

113

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

114

<pre>Creates a new ScanConfig.

115

116

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

117

parent: string, Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. (required)

Dan O'Meara

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

[diff] [blame]

118

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

119

The object takes the form of:

120

121

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

122

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

123

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

124

"name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.

125

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

126

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

127

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

128

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

129

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.

130

},

131

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

132

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

133

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

134

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

135

},

136

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

137

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

138

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.

139

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

140

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

141

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

142

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

143

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

144

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.

145

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

146

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

147

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

148

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

149

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

150

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

151

"progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

152

"errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.

153

"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

154

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

155

"fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

156

},

157

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

158

"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.

159

},

160

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

161

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

162

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

163

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

164

},

165

],

166

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

167

"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

168

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

169

"name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

170

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

171

},

172

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

173

"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

174

"A String",

175

],

176

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

177

"A String",

178

],

179

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

180

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

181

"A String",

182

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

183

}

184

185

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

192

193

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

194

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

195

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

196

"name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.

197

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

198

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

199

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

200

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

201

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.

202

},

203

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

204

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

205

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

206

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

207

},

208

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

209

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

210

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.

211

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

212

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

213

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

214

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

215

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

216

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.

217

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

218

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

219

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

220

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

221

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

222

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

223

"progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

224

"errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.

225

"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

226

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

227

"fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

228

},

229

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

230

"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.

231

},

232

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

233

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

234

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

235

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

236

},

237

],

238

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

239

"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

240

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

241

"name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

242

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

243

},

244

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

245

"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

246

"A String",

247

],

248

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

249

"A String",

250

],

251

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

252

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

253

"A String",

254

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

255

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

260

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

261

262

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

263

name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the 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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

272

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

278

<pre>Gets a ScanConfig.

279

280

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

281

name: string, Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

Bu Sun Kim

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

[diff] [blame]

282

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

289

290

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

291

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

292

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

293

"name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.

294

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

295

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

296

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

297

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

298

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.

299

},

300

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

301

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

302

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

303

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

304

},

305

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

306

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

307

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.

308

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

309

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

310

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

311

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

312

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

313

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.

314

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

315

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

316

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

317

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

318

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

319

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

320

"progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

321

"errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.

322

"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

323

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

324

"fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

325

},

326

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

327

"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.

328

},

329

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

330

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

331

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

332

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

333

},

334

],

335

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

336

"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

337

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

338

"name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

339

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

340

},

341

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

342

"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

343

"A String",

344

],

345

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

346

"A String",

347

],

348

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

349

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

350

"A String",

351

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

352

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

356

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

357

<pre>Lists ScanConfigs under a given project.

358

359

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

360

parent: string, Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. (required)

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

361

pageToken: string, A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

362

pageSize: integer, The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.

Bu Sun Kim

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

[diff] [blame]

363

x__xgafv: string, V1 error format.

364

Allowed values

365

1 - v1 error format

366

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

367

368

Returns:

369

An object of the form:

370

371

{ # Response for the `ListScanConfigs` method.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

372

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

Bu Sun Kim

6502091

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

[diff] [blame]

373

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

Bu Sun Kim

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

[diff] [blame]

374

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

375

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

376

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

377

"name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.

378

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

379

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

380

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

381

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

382

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.

383

},

384

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

385

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

386

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

387

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

388

},

389

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

390

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

391

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.

392

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

393

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

394

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

395

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

396

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

397

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.

398

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

399

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

400

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

401

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

402

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

403

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

404

"progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

405

"errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.

406

"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

407

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

408

"fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

409

},

410

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

411

"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.

412

},

413

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

414

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

415

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

416

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

417

},

418

],

419

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

420

"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

421

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

422

"name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

423

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

424

},

425

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

426

"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

427

"A String",

428

],

429

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

430

"A String",

431

],

432

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

433

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

434

"A String",

435

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

436

},

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>

443

<pre>Retrieves the next page of results.

444

445

Args:

446

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

447

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

448

449

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

450

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]

451

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]

456

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

457

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

458

459

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

460

name: string, The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. (required)

Dan O'Meara

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

[diff] [blame]

461

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

462

The object takes the form of:

463

464

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

465

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

466

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

467

"name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.

468

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

469

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

470

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

471

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

472

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.

473

},

474

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

475

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

476

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

477

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

478

},

479

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

480

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

481

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.

482

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

483

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

484

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

485

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

486

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

487

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.

488

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

489

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

490

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

491

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

492

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

493

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

494

"progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

495

"errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.

496

"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

497

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

498

"fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

499

},

500

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

501

"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.

502

},

503

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

504

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

505

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

506

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

507

},

508

],

509

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

510

"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

511

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

512

"name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

513

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

514

},

515

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

516

"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

517

"A String",

518

],

519

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

520

"A String",

521

],

522

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

523

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

524

"A String",

525

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

526

}

Bu Sun Kim

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

[diff] [blame]

527

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

528

updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Bu Sun Kim

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

[diff] [blame]

529

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

536

537

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

538

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

539

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

540

"name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.

541

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

542

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

543

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

544

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

545

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.

546

},

547

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

548

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

549

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

550

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

551

},

552

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

553

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

554

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.

555

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

556

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

557

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

558

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

559

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

560

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.

561

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

562

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

563

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

564

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

565

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

566

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

567

"progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

568

"errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.

569

"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

570

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

571

"fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

572

},

573

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

574

"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.

575

},

576

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

577

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

578

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

579

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

580

},

581

],

582

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

583

"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

584

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

585

"name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

586

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

587

},

588

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

589

"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

590

"A String",

591

],

592

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

593

"A String",

594

],

595

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

596

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

597

"A String",

598

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

599

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

604

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

605

606

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

607

name: string, Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

Bu Sun Kim

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

[diff] [blame]

608

body: object, The request body.

609

The object takes the form of:

610

611

{ # Request for the `StartScanRun` method.

612

}

613

614

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

621

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

622

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

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

623

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

624

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

625

"progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

626

"errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.

627

"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

628

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

629

"fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

630

},

631

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

632

"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.

633

},

634

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

Bu Sun Kim

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

[diff] [blame]

635

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

636

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

Bu Sun Kim

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

[diff] [blame]

637

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

638

},

639

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

640

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

641

"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

642

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

643

"name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

644

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

Bu Sun Kim