Blame - docs/dyn/websecurityscanner_v1.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

Bu Sun Kim

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

[diff] [blame]

86

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

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

Dmitry Frenkel

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

[diff] [blame]

95

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

Bu Sun Kim

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

101

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

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>

Bu Sun Kim

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

[diff] [blame]

113

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

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)

Bu Sun Kim

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

[diff] [blame]

118

body: object, The request body.

119

The object takes the form of:

120

121

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

Bu Sun Kim

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

[diff] [blame]

122

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

123

"A String",

124

],

Dmitry Frenkel

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

[diff] [blame]

125

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

126

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

127

"A String",

128

],

129

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

Bu Sun Kim

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

[diff] [blame]

130

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

Dmitry Frenkel

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

[diff] [blame]

131

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

132

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

Bu Sun Kim

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

[diff] [blame]

133

},

134

},

Dmitry Frenkel

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

[diff] [blame]

135

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

136

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

137

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

138

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

139

},

Bu Sun Kim

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

[diff] [blame]

140

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

141

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

Dmitry Frenkel

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

[diff] [blame]

142

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

Bu Sun Kim

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

[diff] [blame]

143

},

144

},

Dmitry Frenkel

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

[diff] [blame]

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

},

155

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

Bu Sun Kim

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

[diff] [blame]

156

}

Bu Sun Kim

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

[diff] [blame]

157

158

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

165

166

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

Bu Sun Kim

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

[diff] [blame]

167

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

168

"A String",

169

],

Dmitry Frenkel

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

[diff] [blame]

170

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

171

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

172

"A String",

173

],

174

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

Bu Sun Kim

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

[diff] [blame]

175

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

Dmitry Frenkel

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

[diff] [blame]

176

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

177

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

Bu Sun Kim

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

[diff] [blame]

178

},

179

},

Dmitry Frenkel

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

[diff] [blame]

180

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

181

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

182

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

183

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

184

},

Bu Sun Kim

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

[diff] [blame]

185

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

186

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

Dmitry Frenkel

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

[diff] [blame]

187

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

Bu Sun Kim

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

[diff] [blame]

188

},

189

},

Dmitry Frenkel

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

[diff] [blame]

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

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

198

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

199

},

200

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

Bu Sun Kim

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

[diff] [blame]

201

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

206

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

207

208

Args:

Dmitry Frenkel

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

[diff] [blame]

209

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

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

[diff] [blame]

210

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

217

Dmitry Frenkel

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

[diff] [blame]

218

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

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

[diff] [blame]

}</pre>

</div>

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

224

<pre>Gets a ScanConfig.

225

226

Args:

Dmitry Frenkel

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

[diff] [blame]

227

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

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

[diff] [blame]

228

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

235

236

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

Bu Sun Kim

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

[diff] [blame]

237

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

238

"A String",

239

],

Dmitry Frenkel

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

[diff] [blame]

240

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

241

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

242

"A String",

243

],

244

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

Bu Sun Kim

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

[diff] [blame]

245

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

Dmitry Frenkel

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

[diff] [blame]

246

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

247

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

Bu Sun Kim

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

[diff] [blame]

248

},

249

},

Dmitry Frenkel

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

[diff] [blame]

250

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

251

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

252

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

253

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

254

},

Bu Sun Kim

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

[diff] [blame]

255

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

256

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

Dmitry Frenkel

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

[diff] [blame]

257

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

Bu Sun Kim

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

[diff] [blame]

258

},

259

},

Dmitry Frenkel

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

[diff] [blame]

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

},

270

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

Bu Sun Kim

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

[diff] [blame]

271

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

275

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

Bu Sun Kim

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

[diff] [blame]

276

<pre>Lists ScanConfigs under a given project.

277

278

Args:

Dmitry Frenkel

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

[diff] [blame]

279

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

280

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.

281

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.

Bu Sun Kim

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

{ # Response for the `ListScanConfigs` method.

Dmitry Frenkel

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

[diff] [blame]

291

"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

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

[diff] [blame]

292

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

293

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

Bu Sun Kim

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

[diff] [blame]

294

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

295

"A String",

296

],

Dmitry Frenkel

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

[diff] [blame]

297

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

298

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

299

"A String",

300

],

301

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

Bu Sun Kim

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

[diff] [blame]

302

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

Dmitry Frenkel

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

[diff] [blame]

303

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

304

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

Bu Sun Kim

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

[diff] [blame]

305

},

306

},

Dmitry Frenkel

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

[diff] [blame]

307

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

308

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

309

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

310

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

311

},

Bu Sun Kim

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

[diff] [blame]

312

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

313

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

Dmitry Frenkel

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

[diff] [blame]

314

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

Bu Sun Kim

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

[diff] [blame]

315

},

316

},

Dmitry Frenkel

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

[diff] [blame]

317

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

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

},

327

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

Bu Sun Kim

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

[diff] [blame]

328

},

Bu Sun Kim

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

[diff] [blame]

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

335

<pre>Retrieves the next page of results.

336

337

Args:

338

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

339

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

340

341

Returns:

342

A request object that you can call 'execute()' on to request the next

343

page. Returns None if there are no more items in the collection.

</pre>

</div>

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

349

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

350

351

Args:

Dmitry Frenkel

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

[diff] [blame]

352

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)

Bu Sun Kim

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

[diff] [blame]

353

body: object, The request body.

354

The object takes the form of:

355

356

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

Bu Sun Kim

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

[diff] [blame]

357

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

358

"A String",

359

],

Dmitry Frenkel

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

[diff] [blame]

360

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

361

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

362

"A String",

363

],

364

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

Bu Sun Kim

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

[diff] [blame]

365

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

Dmitry Frenkel

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

[diff] [blame]

366

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

367

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

Bu Sun Kim

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

[diff] [blame]

368

},

369

},

Dmitry Frenkel

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

[diff] [blame]

370

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

371

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

372

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

373

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

374

},

Bu Sun Kim

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

[diff] [blame]

375

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

376

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

Dmitry Frenkel

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

[diff] [blame]

377

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

Bu Sun Kim

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

[diff] [blame]

378

},

379

},

Dmitry Frenkel

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

[diff] [blame]

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

},

390

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

Bu Sun Kim

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

[diff] [blame]

391

}

Bu Sun Kim

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

[diff] [blame]

392

Dmitry Frenkel

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

[diff] [blame]

393

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

[diff] [blame]

394

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

401

402

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

Bu Sun Kim

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

[diff] [blame]

403

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

404

"A String",

405

],

Dmitry Frenkel

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

[diff] [blame]

406

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

407

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

408

"A String",

409

],

410

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

Bu Sun Kim

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

[diff] [blame]

411

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

Dmitry Frenkel

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

[diff] [blame]

412

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

413

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

Bu Sun Kim

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

[diff] [blame]

414

},

415

},

Dmitry Frenkel

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

[diff] [blame]

416

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

417

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

418

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

419

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

420

},

Bu Sun Kim

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

[diff] [blame]

421

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

422

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

Dmitry Frenkel

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

[diff] [blame]

423

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

Bu Sun Kim

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

[diff] [blame]

424

},

425

},

Dmitry Frenkel

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

[diff] [blame]

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

},

436

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

Bu Sun Kim

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

[diff] [blame]

437

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

442

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

443

444

Args:

Dmitry Frenkel

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

[diff] [blame]

445

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

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

[diff] [blame]

446

body: object, The request body.

447

The object takes the form of:

448

449

{ # Request for the `StartScanRun` method.

450

}

451

452

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

459

Dmitry Frenkel

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

[diff] [blame]

460

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

461

"urlsTestedCount": "A String", # Output only. 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.

462

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

463

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

464

"urlsCrawledCount": "A String", # Output only. 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.

465

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

466

"mostCommonHttpErrorCode": 42, # Output only. 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.

467

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

468

"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. # Output only. 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.

469

"fieldName": "A String", # Output only. 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.

Bu Sun Kim

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

[diff] [blame]

470

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

Bu Sun Kim

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

[diff] [blame]

471

},

Bu Sun Kim

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

[diff] [blame]

472

},

Dmitry Frenkel

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

[diff] [blame]

473

"name": "A String", # Output only. 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.

474

"progressPercent": 42, # Output only. 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.

475

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

476

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

477

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

Dmitry Frenkel

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

[diff] [blame]

478

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

4ed7d3f

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

[diff] [blame]

479

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

480

},

481

],

Dmitry Frenkel