1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="websecurityscanner_v1.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1.projects.html">projects</a> . <a href="websecurityscanner_v1.projects.scanConfigs.html">scanConfigs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.html">scanRuns()</a></code>
</p>
<p class="firstline">Returns the scanRuns Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new ScanConfig.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing ScanConfig and its child resources.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a ScanConfig.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists ScanConfigs under a given project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a ScanConfig. This method support partial update of a ScanConfig.</p>
<p class="toc_element">
<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Start a ScanRun according to the given ScanConfig.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new ScanConfig.
Args:
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)
body: object, The request body.
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
"loginUrl": "A String", # Required. The login form URL of the website.
"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.
"username": "A String", # Required. The user name of the custom account.
},
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
"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.
"username": "A String", # Required. The user name of the Google account.
},
"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
"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.
"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
},
},
},
"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
"A String",
],
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
"endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
"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.
"code": "A String", # Output only. Indicates the error reason code.
"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.
"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.
"code": "A String", # Output only. Indicates the reason code for a configuration failure.
"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.
},
},
"executionState": "A String", # Output only. The execution state of the ScanRun.
"hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
"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.
"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.
"resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
"startTime": "A String", # Output only. The time at which the ScanRun started.
"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.
"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.
"warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
"code": "A String", # Output only. Indicates the warning code.
},
],
},
"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"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.
"name": "A String", # Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
"riskLevel": "A String", # The risk level selected for the scan
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
"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.
},
"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"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.
"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
"A String",
],
"userAgent": "A String", # The user agent used during scanning.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
"loginUrl": "A String", # Required. The login form URL of the website.
"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.
"username": "A String", # Required. The user name of the custom account.
},
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
"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.
"username": "A String", # Required. The user name of the Google account.
},
"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
"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.
"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
},
},
},
"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
"A String",
],
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
"endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
"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.
"code": "A String", # Output only. Indicates the error reason code.
"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.
"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.
"code": "A String", # Output only. Indicates the reason code for a configuration failure.
"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.
},
},
"executionState": "A String", # Output only. The execution state of the ScanRun.
"hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
"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.
"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.
"resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
"startTime": "A String", # Output only. The time at which the ScanRun started.
"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.
"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.
"warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
"code": "A String", # Output only. Indicates the warning code.
},
],
},
"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"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.
"name": "A String", # Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
"riskLevel": "A String", # The risk level selected for the scan
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
"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.
},
"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"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.
"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
"A String",
],
"userAgent": "A String", # The user agent used during scanning.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an existing ScanConfig and its child resources.
Args:
name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a ScanConfig.
Args:
name: string, Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
"loginUrl": "A String", # Required. The login form URL of the website.
"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.
"username": "A String", # Required. The user name of the custom account.
},
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
"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.
"username": "A String", # Required. The user name of the Google account.
},
"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
"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.
"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
},
},
},
"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
"A String",
],
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
"endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
"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.
"code": "A String", # Output only. Indicates the error reason code.
"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.
"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.
"code": "A String", # Output only. Indicates the reason code for a configuration failure.
"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.
},
},
"executionState": "A String", # Output only. The execution state of the ScanRun.
"hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
"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.
"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.
"resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
"startTime": "A String", # Output only. The time at which the ScanRun started.
"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.
"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.
"warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
"code": "A String", # Output only. Indicates the warning code.
},
],
},
"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"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.
"name": "A String", # Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
"riskLevel": "A String", # The risk level selected for the scan
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
"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.
},
"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"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.
"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
"A String",
],
"userAgent": "A String", # The user agent used during scanning.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists ScanConfigs under a given project.
Args:
parent: string, Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. (required)
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.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for the `ListScanConfigs` method.
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"scanConfigs": [ # The list of ScanConfigs returned.
{ # A ScanConfig resource contains the configurations to launch a scan.
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
"loginUrl": "A String", # Required. The login form URL of the website.
"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.
"username": "A String", # Required. The user name of the custom account.
},
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
"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.
"username": "A String", # Required. The user name of the Google account.
},
"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
"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.
"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
},
},
},
"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
"A String",
],
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
"endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
"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.
"code": "A String", # Output only. Indicates the error reason code.
"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.
"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.
"code": "A String", # Output only. Indicates the reason code for a configuration failure.
"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.
},
},
"executionState": "A String", # Output only. The execution state of the ScanRun.
"hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
"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.
"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.
"resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
"startTime": "A String", # Output only. The time at which the ScanRun started.
"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.
"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.
"warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
"code": "A String", # Output only. Indicates the warning code.
},
],
},
"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"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.
"name": "A String", # Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
"riskLevel": "A String", # The risk level selected for the scan
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
"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.
},
"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"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.
"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
"A String",
],
"userAgent": "A String", # The user agent used during scanning.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a ScanConfig. This method support partial update of a ScanConfig.
Args:
name: string, Identifier. 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)
body: object, The request body.
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
"loginUrl": "A String", # Required. The login form URL of the website.
"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.
"username": "A String", # Required. The user name of the custom account.
},
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
"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.
"username": "A String", # Required. The user name of the Google account.
},
"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
"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.
"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
},
},
},
"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
"A String",
],
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
"endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
"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.
"code": "A String", # Output only. Indicates the error reason code.
"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.
"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.
"code": "A String", # Output only. Indicates the reason code for a configuration failure.
"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.
},
},
"executionState": "A String", # Output only. The execution state of the ScanRun.
"hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
"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.
"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.
"resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
"startTime": "A String", # Output only. The time at which the ScanRun started.
"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.
"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.
"warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
"code": "A String", # Output only. Indicates the warning code.
},
],
},
"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"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.
"name": "A String", # Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
"riskLevel": "A String", # The risk level selected for the scan
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
"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.
},
"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"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.
"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
"A String",
],
"userAgent": "A String", # The user agent used during scanning.
}
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
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
"loginUrl": "A String", # Required. The login form URL of the website.
"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.
"username": "A String", # Required. The user name of the custom account.
},
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
"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.
"username": "A String", # Required. The user name of the Google account.
},
"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
"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.
"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
},
},
},
"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
"A String",
],
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
"endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
"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.
"code": "A String", # Output only. Indicates the error reason code.
"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.
"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.
"code": "A String", # Output only. Indicates the reason code for a configuration failure.
"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.
},
},
"executionState": "A String", # Output only. The execution state of the ScanRun.
"hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
"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.
"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.
"resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
"startTime": "A String", # Output only. The time at which the ScanRun started.
"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.
"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.
"warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
"code": "A String", # Output only. Indicates the warning code.
},
],
},
"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"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.
"name": "A String", # Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
"riskLevel": "A String", # The risk level selected for the scan
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
"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.
},
"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"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.
"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
"A String",
],
"userAgent": "A String", # The user agent used during scanning.
}</pre>
</div>
<div class="method">
<code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
<pre>Start a ScanRun according to the given ScanConfig.
Args:
name: string, Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
body: object, The request body.
The object takes the form of:
{ # Request for the `StartScanRun` method.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
"endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
"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.
"code": "A String", # Output only. Indicates the error reason code.
"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.
"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.
"code": "A String", # Output only. Indicates the reason code for a configuration failure.
"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.
},
},
"executionState": "A String", # Output only. The execution state of the ScanRun.
"hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
"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.
"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.
"resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
"startTime": "A String", # Output only. The time at which the ScanRun started.
"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.
"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.
"warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
"code": "A String", # Output only. Indicates the warning code.
},
],
}</pre>
</div>
</body></html>
|
