Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / websecurityscanner_v1beta.projects.scanConfigs.html
blob: 65e169263e1954c85e181b6a5f4bacc5b8ebaef3 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="websecurityscanner_v1beta.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1beta.projects.html">projects</a> . <a href="websecurityscanner_v1beta.projects.scanConfigs.html">scanConfigs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html">scanRuns()</a></code>
79</p>
80<p class="firstline">Returns the scanRuns Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
84<p class="firstline">Creates a new ScanConfig.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes an existing ScanConfig and its child resources.</p>
88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Gets a ScanConfig.</p>
91<p class="toc_element">
92 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
93<p class="firstline">Lists ScanConfigs under a given project.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
97<p class="toc_element">
98 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
99<p class="firstline">Updates a ScanConfig. This method support partial update of a ScanConfig.</p>
100<p class="toc_element">
101 <code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Start a ScanRun according to the given ScanConfig.</p>
103<h3>Method Details</h3>
104<div class="method">
105 <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
106 <pre>Creates a new ScanConfig.
107
108Args:
109 parent: string, Required.
110The parent resource name where the scan is created, which should be a
111project resource name in the format 'projects/{projectId}'. (required)
112 body: object, The request body. (required)
113 The object takes the form of:
114
115{ # A ScanConfig resource contains the configurations to launch a scan.
116 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
117 # inclusively. If the field is unspecified or its value is set 0, server will
118 # default to 15. Other values outside of [5, 20] range will be rejected with
119 # INVALID_ARGUMENT error.
120 "displayName": "A String", # Required.
121 # The user provided display name of the ScanConfig.
122 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
123 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
124 # generated by the system.
125 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
126 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
127 # refreshed by the server after each run. If unspecified, it will default
128 # to current server time, which means the scan will be scheduled to start
129 # immediately.
130 "intervalDurationDays": 42, # Required.
131 # The duration of time between executions in days.
132 },
133 "riskLevel": "A String", # The risk level selected for the scan
134 "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
135 # Command Center.
136 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
137 # used as a default.
138 "A String",
139 ],
140 "blacklistPatterns": [ # The blacklist URL patterns as described in
141 # https://cloud.google.com/security-scanner/docs/excluded-urls
142 "A String",
143 ],
144 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
145 # authentication configuration during scanning.
146 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
147 "username": "A String", # Required.
148 # The user name of the Google account.
149 "password": "A String", # Input only.
150 # Required.
151 # The password of the Google account. The credential is stored encrypted
152 # and not returned in any response nor included in audit logs.
153 },
154 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
155 "username": "A String", # Required.
156 # The user name of the custom account.
157 "loginUrl": "A String", # Required.
158 # The login form URL of the website.
159 "password": "A String", # Input only.
160 # Required.
161 # The password of the custom account. The credential is stored encrypted
162 # and not returned in any response nor included in audit logs.
163 },
164 },
165 "userAgent": "A String", # The user agent used during scanning.
166 "startingUrls": [ # Required.
167 # The starting URLs from which the scanner finds site pages.
168 "A String",
169 ],
170 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
171 # Next id: 12
172 "warningTraces": [ # Output only.
173 # A list of warnings, if such are encountered during this scan run.
174 { # Output only.
175 # Defines a warning trace message for ScanRun. Warning traces provide customers
176 # with useful information that helps make the scanning process more effective.
177 "code": "A String", # Output only.
178 # Indicates the warning code.
179 },
180 ],
181 "name": "A String", # Output only.
182 # The resource name of the ScanRun. The name follows the format of
183 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
184 # The ScanRun IDs are generated by the system.
185 "executionState": "A String", # Output only.
186 # The execution state of the ScanRun.
187 "urlsTestedCount": "A String", # Output only.
188 # The number of URLs tested during this ScanRun. If the scan is in progress,
189 # the value represents the number of URLs tested up to now. The number of
190 # URLs tested is usually larger than the number URLS crawled because
191 # typically a crawled URL is tested with multiple test payloads.
192 "progressPercent": 42, # Output only.
193 # The percentage of total completion ranging from 0 to 100.
194 # If the scan is in queue, the value is 0.
195 # If the scan is running, the value ranges from 0 to 100.
196 # If the scan is finished, the value is 100.
197 "errorTrace": { # Output only. # Output only.
198 # If result_state is an ERROR, this field provides the primary reason for
199 # scan's termination and more details, if such are available.
200 # Defines an error trace message for a ScanRun.
201 "mostCommonHttpErrorCode": 42, # Output only.
202 # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
203 # common HTTP error code, if such is available. For example, if this code is
204 # 404, the scan has encountered too many NOT_FOUND responses.
205 "code": "A String", # Output only.
206 # Indicates the error reason code.
207 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
208 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
209 # message encountered during scan configuration validation that is performed
210 # before each scan run.
211 # APIs when scan configuration validation fails. It is also reported as part of
212 # a ScanRunErrorTrace message if scan validation fails due to a scan
213 # configuration error.
214 "code": "A String", # Output only.
215 # Indicates the reason code for a configuration failure.
216 "fieldName": "A String", # Output only.
217 # Indicates the full name of the ScanConfig field that triggers this error,
218 # for example "scan_config.max_qps". This field is provided for
219 # troubleshooting purposes only and its actual value can change in the
220 # future.
221 },
222 },
223 "resultState": "A String", # Output only.
224 # The result state of the ScanRun. This field is only available after the
225 # execution state reaches "FINISHED".
226 "startTime": "A String", # Output only.
227 # The time at which the ScanRun started.
228 "endTime": "A String", # Output only.
229 # The time at which the ScanRun reached termination state - that the ScanRun
230 # is either finished or stopped by user.
231 "hasVulnerabilities": True or False, # Output only.
232 # Whether the scan run has found any vulnerabilities.
233 "urlsCrawledCount": "A String", # Output only.
234 # The number of URLs crawled during this ScanRun. If the scan is in progress,
235 # the value represents the number of URLs crawled up to now.
236 },
237}
238
239 x__xgafv: string, V1 error format.
240 Allowed values
241 1 - v1 error format
242 2 - v2 error format
243
244Returns:
245 An object of the form:
246
247 { # A ScanConfig resource contains the configurations to launch a scan.
248 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
249 # inclusively. If the field is unspecified or its value is set 0, server will
250 # default to 15. Other values outside of [5, 20] range will be rejected with
251 # INVALID_ARGUMENT error.
252 "displayName": "A String", # Required.
253 # The user provided display name of the ScanConfig.
254 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
255 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
256 # generated by the system.
257 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
258 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
259 # refreshed by the server after each run. If unspecified, it will default
260 # to current server time, which means the scan will be scheduled to start
261 # immediately.
262 "intervalDurationDays": 42, # Required.
263 # The duration of time between executions in days.
264 },
265 "riskLevel": "A String", # The risk level selected for the scan
266 "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
267 # Command Center.
268 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
269 # used as a default.
270 "A String",
271 ],
272 "blacklistPatterns": [ # The blacklist URL patterns as described in
273 # https://cloud.google.com/security-scanner/docs/excluded-urls
274 "A String",
275 ],
276 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
277 # authentication configuration during scanning.
278 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
279 "username": "A String", # Required.
280 # The user name of the Google account.
281 "password": "A String", # Input only.
282 # Required.
283 # The password of the Google account. The credential is stored encrypted
284 # and not returned in any response nor included in audit logs.
285 },
286 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
287 "username": "A String", # Required.
288 # The user name of the custom account.
289 "loginUrl": "A String", # Required.
290 # The login form URL of the website.
291 "password": "A String", # Input only.
292 # Required.
293 # The password of the custom account. The credential is stored encrypted
294 # and not returned in any response nor included in audit logs.
295 },
296 },
297 "userAgent": "A String", # The user agent used during scanning.
298 "startingUrls": [ # Required.
299 # The starting URLs from which the scanner finds site pages.
300 "A String",
301 ],
302 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
303 # Next id: 12
304 "warningTraces": [ # Output only.
305 # A list of warnings, if such are encountered during this scan run.
306 { # Output only.
307 # Defines a warning trace message for ScanRun. Warning traces provide customers
308 # with useful information that helps make the scanning process more effective.
309 "code": "A String", # Output only.
310 # Indicates the warning code.
311 },
312 ],
313 "name": "A String", # Output only.
314 # The resource name of the ScanRun. The name follows the format of
315 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
316 # The ScanRun IDs are generated by the system.
317 "executionState": "A String", # Output only.
318 # The execution state of the ScanRun.
319 "urlsTestedCount": "A String", # Output only.
320 # The number of URLs tested during this ScanRun. If the scan is in progress,
321 # the value represents the number of URLs tested up to now. The number of
322 # URLs tested is usually larger than the number URLS crawled because
323 # typically a crawled URL is tested with multiple test payloads.
324 "progressPercent": 42, # Output only.
325 # The percentage of total completion ranging from 0 to 100.
326 # If the scan is in queue, the value is 0.
327 # If the scan is running, the value ranges from 0 to 100.
328 # If the scan is finished, the value is 100.
329 "errorTrace": { # Output only. # Output only.
330 # If result_state is an ERROR, this field provides the primary reason for
331 # scan's termination and more details, if such are available.
332 # Defines an error trace message for a ScanRun.
333 "mostCommonHttpErrorCode": 42, # Output only.
334 # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
335 # common HTTP error code, if such is available. For example, if this code is
336 # 404, the scan has encountered too many NOT_FOUND responses.
337 "code": "A String", # Output only.
338 # Indicates the error reason code.
339 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
340 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
341 # message encountered during scan configuration validation that is performed
342 # before each scan run.
343 # APIs when scan configuration validation fails. It is also reported as part of
344 # a ScanRunErrorTrace message if scan validation fails due to a scan
345 # configuration error.
346 "code": "A String", # Output only.
347 # Indicates the reason code for a configuration failure.
348 "fieldName": "A String", # Output only.
349 # Indicates the full name of the ScanConfig field that triggers this error,
350 # for example "scan_config.max_qps". This field is provided for
351 # troubleshooting purposes only and its actual value can change in the
352 # future.
353 },
354 },
355 "resultState": "A String", # Output only.
356 # The result state of the ScanRun. This field is only available after the
357 # execution state reaches "FINISHED".
358 "startTime": "A String", # Output only.
359 # The time at which the ScanRun started.
360 "endTime": "A String", # Output only.
361 # The time at which the ScanRun reached termination state - that the ScanRun
362 # is either finished or stopped by user.
363 "hasVulnerabilities": True or False, # Output only.
364 # Whether the scan run has found any vulnerabilities.
365 "urlsCrawledCount": "A String", # Output only.
366 # The number of URLs crawled during this ScanRun. If the scan is in progress,
367 # the value represents the number of URLs crawled up to now.
368 },
369 }</pre>
370</div>
371
372<div class="method">
373 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
374 <pre>Deletes an existing ScanConfig and its child resources.
375
376Args:
377 name: string, Required.
378The resource name of the ScanConfig to be deleted. The name follows the
379format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
380 x__xgafv: string, V1 error format.
381 Allowed values
382 1 - v1 error format
383 2 - v2 error format
384
385Returns:
386 An object of the form:
387
388 { # A generic empty message that you can re-use to avoid defining duplicated
389 # empty messages in your APIs. A typical example is to use it as the request
390 # or the response type of an API method. For instance:
391 #
392 # service Foo {
393 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
394 # }
395 #
396 # The JSON representation for `Empty` is empty JSON object `{}`.
397 }</pre>
398</div>
399
400<div class="method">
401 <code class="details" id="get">get(name, x__xgafv=None)</code>
402 <pre>Gets a ScanConfig.
403
404Args:
405 name: string, Required.
406The resource name of the ScanConfig to be returned. The name follows the
407format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
408 x__xgafv: string, V1 error format.
409 Allowed values
410 1 - v1 error format
411 2 - v2 error format
412
413Returns:
414 An object of the form:
415
416 { # A ScanConfig resource contains the configurations to launch a scan.
417 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
418 # inclusively. If the field is unspecified or its value is set 0, server will
419 # default to 15. Other values outside of [5, 20] range will be rejected with
420 # INVALID_ARGUMENT error.
421 "displayName": "A String", # Required.
422 # The user provided display name of the ScanConfig.
423 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
424 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
425 # generated by the system.
426 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
427 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
428 # refreshed by the server after each run. If unspecified, it will default
429 # to current server time, which means the scan will be scheduled to start
430 # immediately.
431 "intervalDurationDays": 42, # Required.
432 # The duration of time between executions in days.
433 },
434 "riskLevel": "A String", # The risk level selected for the scan
435 "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
436 # Command Center.
437 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
438 # used as a default.
439 "A String",
440 ],
441 "blacklistPatterns": [ # The blacklist URL patterns as described in
442 # https://cloud.google.com/security-scanner/docs/excluded-urls
443 "A String",
444 ],
445 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
446 # authentication configuration during scanning.
447 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
448 "username": "A String", # Required.
449 # The user name of the Google account.
450 "password": "A String", # Input only.
451 # Required.
452 # The password of the Google account. The credential is stored encrypted
453 # and not returned in any response nor included in audit logs.
454 },
455 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
456 "username": "A String", # Required.
457 # The user name of the custom account.
458 "loginUrl": "A String", # Required.
459 # The login form URL of the website.
460 "password": "A String", # Input only.
461 # Required.
462 # The password of the custom account. The credential is stored encrypted
463 # and not returned in any response nor included in audit logs.
464 },
465 },
466 "userAgent": "A String", # The user agent used during scanning.
467 "startingUrls": [ # Required.
468 # The starting URLs from which the scanner finds site pages.
469 "A String",
470 ],
471 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
472 # Next id: 12
473 "warningTraces": [ # Output only.
474 # A list of warnings, if such are encountered during this scan run.
475 { # Output only.
476 # Defines a warning trace message for ScanRun. Warning traces provide customers
477 # with useful information that helps make the scanning process more effective.
478 "code": "A String", # Output only.
479 # Indicates the warning code.
480 },
481 ],
482 "name": "A String", # Output only.
483 # The resource name of the ScanRun. The name follows the format of
484 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
485 # The ScanRun IDs are generated by the system.
486 "executionState": "A String", # Output only.
487 # The execution state of the ScanRun.
488 "urlsTestedCount": "A String", # Output only.
489 # The number of URLs tested during this ScanRun. If the scan is in progress,
490 # the value represents the number of URLs tested up to now. The number of
491 # URLs tested is usually larger than the number URLS crawled because
492 # typically a crawled URL is tested with multiple test payloads.
493 "progressPercent": 42, # Output only.
494 # The percentage of total completion ranging from 0 to 100.
495 # If the scan is in queue, the value is 0.
496 # If the scan is running, the value ranges from 0 to 100.
497 # If the scan is finished, the value is 100.
498 "errorTrace": { # Output only. # Output only.
499 # If result_state is an ERROR, this field provides the primary reason for
500 # scan's termination and more details, if such are available.
501 # Defines an error trace message for a ScanRun.
502 "mostCommonHttpErrorCode": 42, # Output only.
503 # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
504 # common HTTP error code, if such is available. For example, if this code is
505 # 404, the scan has encountered too many NOT_FOUND responses.
506 "code": "A String", # Output only.
507 # Indicates the error reason code.
508 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
509 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
510 # message encountered during scan configuration validation that is performed
511 # before each scan run.
512 # APIs when scan configuration validation fails. It is also reported as part of
513 # a ScanRunErrorTrace message if scan validation fails due to a scan
514 # configuration error.
515 "code": "A String", # Output only.
516 # Indicates the reason code for a configuration failure.
517 "fieldName": "A String", # Output only.
518 # Indicates the full name of the ScanConfig field that triggers this error,
519 # for example "scan_config.max_qps". This field is provided for
520 # troubleshooting purposes only and its actual value can change in the
521 # future.
522 },
523 },
524 "resultState": "A String", # Output only.
525 # The result state of the ScanRun. This field is only available after the
526 # execution state reaches "FINISHED".
527 "startTime": "A String", # Output only.
528 # The time at which the ScanRun started.
529 "endTime": "A String", # Output only.
530 # The time at which the ScanRun reached termination state - that the ScanRun
531 # is either finished or stopped by user.
532 "hasVulnerabilities": True or False, # Output only.
533 # Whether the scan run has found any vulnerabilities.
534 "urlsCrawledCount": "A String", # Output only.
535 # The number of URLs crawled during this ScanRun. If the scan is in progress,
536 # the value represents the number of URLs crawled up to now.
537 },
538 }</pre>
539</div>
540
541<div class="method">
542 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
543 <pre>Lists ScanConfigs under a given project.
544
545Args:
546 parent: string, Required.
547The parent resource name, which should be a project resource name in the
548format 'projects/{projectId}'. (required)
549 pageToken: string, A token identifying a page of results to be returned. This should be a
550`next_page_token` value returned from a previous List request.
551If unspecified, the first page of results is returned.
552 x__xgafv: string, V1 error format.
553 Allowed values
554 1 - v1 error format
555 2 - v2 error format
556 pageSize: integer, The maximum number of ScanConfigs to return, can be limited by server.
557If not specified or not positive, the implementation will select a
558reasonable value.
559
560Returns:
561 An object of the form:
562
563 { # Response for the `ListScanConfigs` method.
564 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
565 # more results in the list.
566 "scanConfigs": [ # The list of ScanConfigs returned.
567 { # A ScanConfig resource contains the configurations to launch a scan.
568 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
569 # inclusively. If the field is unspecified or its value is set 0, server will
570 # default to 15. Other values outside of [5, 20] range will be rejected with
571 # INVALID_ARGUMENT error.
572 "displayName": "A String", # Required.
573 # The user provided display name of the ScanConfig.
574 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
575 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
576 # generated by the system.
577 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
578 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
579 # refreshed by the server after each run. If unspecified, it will default
580 # to current server time, which means the scan will be scheduled to start
581 # immediately.
582 "intervalDurationDays": 42, # Required.
583 # The duration of time between executions in days.
584 },
585 "riskLevel": "A String", # The risk level selected for the scan
586 "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
587 # Command Center.
588 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
589 # used as a default.
590 "A String",
591 ],
592 "blacklistPatterns": [ # The blacklist URL patterns as described in
593 # https://cloud.google.com/security-scanner/docs/excluded-urls
594 "A String",
595 ],
596 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
597 # authentication configuration during scanning.
598 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
599 "username": "A String", # Required.
600 # The user name of the Google account.
601 "password": "A String", # Input only.
602 # Required.
603 # The password of the Google account. The credential is stored encrypted
604 # and not returned in any response nor included in audit logs.
605 },
606 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
607 "username": "A String", # Required.
608 # The user name of the custom account.
609 "loginUrl": "A String", # Required.
610 # The login form URL of the website.
611 "password": "A String", # Input only.
612 # Required.
613 # The password of the custom account. The credential is stored encrypted
614 # and not returned in any response nor included in audit logs.
615 },
616 },
617 "userAgent": "A String", # The user agent used during scanning.
618 "startingUrls": [ # Required.
619 # The starting URLs from which the scanner finds site pages.
620 "A String",
621 ],
622 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
623 # Next id: 12
624 "warningTraces": [ # Output only.
625 # A list of warnings, if such are encountered during this scan run.
626 { # Output only.
627 # Defines a warning trace message for ScanRun. Warning traces provide customers
628 # with useful information that helps make the scanning process more effective.
629 "code": "A String", # Output only.
630 # Indicates the warning code.
631 },
632 ],
633 "name": "A String", # Output only.
634 # The resource name of the ScanRun. The name follows the format of
635 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
636 # The ScanRun IDs are generated by the system.
637 "executionState": "A String", # Output only.
638 # The execution state of the ScanRun.
639 "urlsTestedCount": "A String", # Output only.
640 # The number of URLs tested during this ScanRun. If the scan is in progress,
641 # the value represents the number of URLs tested up to now. The number of
642 # URLs tested is usually larger than the number URLS crawled because
643 # typically a crawled URL is tested with multiple test payloads.
644 "progressPercent": 42, # Output only.
645 # The percentage of total completion ranging from 0 to 100.
646 # If the scan is in queue, the value is 0.
647 # If the scan is running, the value ranges from 0 to 100.
648 # If the scan is finished, the value is 100.
649 "errorTrace": { # Output only. # Output only.
650 # If result_state is an ERROR, this field provides the primary reason for
651 # scan's termination and more details, if such are available.
652 # Defines an error trace message for a ScanRun.
653 "mostCommonHttpErrorCode": 42, # Output only.
654 # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
655 # common HTTP error code, if such is available. For example, if this code is
656 # 404, the scan has encountered too many NOT_FOUND responses.
657 "code": "A String", # Output only.
658 # Indicates the error reason code.
659 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
660 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
661 # message encountered during scan configuration validation that is performed
662 # before each scan run.
663 # APIs when scan configuration validation fails. It is also reported as part of
664 # a ScanRunErrorTrace message if scan validation fails due to a scan
665 # configuration error.
666 "code": "A String", # Output only.
667 # Indicates the reason code for a configuration failure.
668 "fieldName": "A String", # Output only.
669 # Indicates the full name of the ScanConfig field that triggers this error,
670 # for example "scan_config.max_qps". This field is provided for
671 # troubleshooting purposes only and its actual value can change in the
672 # future.
673 },
674 },
675 "resultState": "A String", # Output only.
676 # The result state of the ScanRun. This field is only available after the
677 # execution state reaches "FINISHED".
678 "startTime": "A String", # Output only.
679 # The time at which the ScanRun started.
680 "endTime": "A String", # Output only.
681 # The time at which the ScanRun reached termination state - that the ScanRun
682 # is either finished or stopped by user.
683 "hasVulnerabilities": True or False, # Output only.
684 # Whether the scan run has found any vulnerabilities.
685 "urlsCrawledCount": "A String", # Output only.
686 # The number of URLs crawled during this ScanRun. If the scan is in progress,
687 # the value represents the number of URLs crawled up to now.
688 },
689 },
690 ],
691 }</pre>
692</div>
693
694<div class="method">
695 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
696 <pre>Retrieves the next page of results.
697
698Args:
699 previous_request: The request for the previous page. (required)
700 previous_response: The response from the request for the previous page. (required)
701
702Returns:
703 A request object that you can call 'execute()' on to request the next
704 page. Returns None if there are no more items in the collection.
705 </pre>
706</div>
707
708<div class="method">
709 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
710 <pre>Updates a ScanConfig. This method support partial update of a ScanConfig.
711
712Args:
713 name: string, The resource name of the ScanConfig. The name follows the format of
714'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
715generated by the system. (required)
716 body: object, The request body. (required)
717 The object takes the form of:
718
719{ # A ScanConfig resource contains the configurations to launch a scan.
720 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
721 # inclusively. If the field is unspecified or its value is set 0, server will
722 # default to 15. Other values outside of [5, 20] range will be rejected with
723 # INVALID_ARGUMENT error.
724 "displayName": "A String", # Required.
725 # The user provided display name of the ScanConfig.
726 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
727 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
728 # generated by the system.
729 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
730 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
731 # refreshed by the server after each run. If unspecified, it will default
732 # to current server time, which means the scan will be scheduled to start
733 # immediately.
734 "intervalDurationDays": 42, # Required.
735 # The duration of time between executions in days.
736 },
737 "riskLevel": "A String", # The risk level selected for the scan
738 "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
739 # Command Center.
740 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
741 # used as a default.
742 "A String",
743 ],
744 "blacklistPatterns": [ # The blacklist URL patterns as described in
745 # https://cloud.google.com/security-scanner/docs/excluded-urls
746 "A String",
747 ],
748 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
749 # authentication configuration during scanning.
750 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
751 "username": "A String", # Required.
752 # The user name of the Google account.
753 "password": "A String", # Input only.
754 # Required.
755 # The password of the Google account. The credential is stored encrypted
756 # and not returned in any response nor included in audit logs.
757 },
758 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
759 "username": "A String", # Required.
760 # The user name of the custom account.
761 "loginUrl": "A String", # Required.
762 # The login form URL of the website.
763 "password": "A String", # Input only.
764 # Required.
765 # The password of the custom account. The credential is stored encrypted
766 # and not returned in any response nor included in audit logs.
767 },
768 },
769 "userAgent": "A String", # The user agent used during scanning.
770 "startingUrls": [ # Required.
771 # The starting URLs from which the scanner finds site pages.
772 "A String",
773 ],
774 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
775 # Next id: 12
776 "warningTraces": [ # Output only.
777 # A list of warnings, if such are encountered during this scan run.
778 { # Output only.
779 # Defines a warning trace message for ScanRun. Warning traces provide customers
780 # with useful information that helps make the scanning process more effective.
781 "code": "A String", # Output only.
782 # Indicates the warning code.
783 },
784 ],
785 "name": "A String", # Output only.
786 # The resource name of the ScanRun. The name follows the format of
787 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
788 # The ScanRun IDs are generated by the system.
789 "executionState": "A String", # Output only.
790 # The execution state of the ScanRun.
791 "urlsTestedCount": "A String", # Output only.
792 # The number of URLs tested during this ScanRun. If the scan is in progress,
793 # the value represents the number of URLs tested up to now. The number of
794 # URLs tested is usually larger than the number URLS crawled because
795 # typically a crawled URL is tested with multiple test payloads.
796 "progressPercent": 42, # Output only.
797 # The percentage of total completion ranging from 0 to 100.
798 # If the scan is in queue, the value is 0.
799 # If the scan is running, the value ranges from 0 to 100.
800 # If the scan is finished, the value is 100.
801 "errorTrace": { # Output only. # Output only.
802 # If result_state is an ERROR, this field provides the primary reason for
803 # scan's termination and more details, if such are available.
804 # Defines an error trace message for a ScanRun.
805 "mostCommonHttpErrorCode": 42, # Output only.
806 # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
807 # common HTTP error code, if such is available. For example, if this code is
808 # 404, the scan has encountered too many NOT_FOUND responses.
809 "code": "A String", # Output only.
810 # Indicates the error reason code.
811 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
812 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
813 # message encountered during scan configuration validation that is performed
814 # before each scan run.
815 # APIs when scan configuration validation fails. It is also reported as part of
816 # a ScanRunErrorTrace message if scan validation fails due to a scan
817 # configuration error.
818 "code": "A String", # Output only.
819 # Indicates the reason code for a configuration failure.
820 "fieldName": "A String", # Output only.
821 # Indicates the full name of the ScanConfig field that triggers this error,
822 # for example "scan_config.max_qps". This field is provided for
823 # troubleshooting purposes only and its actual value can change in the
824 # future.
825 },
826 },
827 "resultState": "A String", # Output only.
828 # The result state of the ScanRun. This field is only available after the
829 # execution state reaches "FINISHED".
830 "startTime": "A String", # Output only.
831 # The time at which the ScanRun started.
832 "endTime": "A String", # Output only.
833 # The time at which the ScanRun reached termination state - that the ScanRun
834 # is either finished or stopped by user.
835 "hasVulnerabilities": True or False, # Output only.
836 # Whether the scan run has found any vulnerabilities.
837 "urlsCrawledCount": "A String", # Output only.
838 # The number of URLs crawled during this ScanRun. If the scan is in progress,
839 # the value represents the number of URLs crawled up to now.
840 },
841}
842
843 updateMask: string, Required.
844The update mask applies to the resource. For the `FieldMask` definition,
845see
846https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
847 x__xgafv: string, V1 error format.
848 Allowed values
849 1 - v1 error format
850 2 - v2 error format
851
852Returns:
853 An object of the form:
854
855 { # A ScanConfig resource contains the configurations to launch a scan.
856 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
857 # inclusively. If the field is unspecified or its value is set 0, server will
858 # default to 15. Other values outside of [5, 20] range will be rejected with
859 # INVALID_ARGUMENT error.
860 "displayName": "A String", # Required.
861 # The user provided display name of the ScanConfig.
862 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
863 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
864 # generated by the system.
865 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
866 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
867 # refreshed by the server after each run. If unspecified, it will default
868 # to current server time, which means the scan will be scheduled to start
869 # immediately.
870 "intervalDurationDays": 42, # Required.
871 # The duration of time between executions in days.
872 },
873 "riskLevel": "A String", # The risk level selected for the scan
874 "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
875 # Command Center.
876 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
877 # used as a default.
878 "A String",
879 ],
880 "blacklistPatterns": [ # The blacklist URL patterns as described in
881 # https://cloud.google.com/security-scanner/docs/excluded-urls
882 "A String",
883 ],
884 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
885 # authentication configuration during scanning.
886 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
887 "username": "A String", # Required.
888 # The user name of the Google account.
889 "password": "A String", # Input only.
890 # Required.
891 # The password of the Google account. The credential is stored encrypted
892 # and not returned in any response nor included in audit logs.
893 },
894 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
895 "username": "A String", # Required.
896 # The user name of the custom account.
897 "loginUrl": "A String", # Required.
898 # The login form URL of the website.
899 "password": "A String", # Input only.
900 # Required.
901 # The password of the custom account. The credential is stored encrypted
902 # and not returned in any response nor included in audit logs.
903 },
904 },
905 "userAgent": "A String", # The user agent used during scanning.
906 "startingUrls": [ # Required.
907 # The starting URLs from which the scanner finds site pages.
908 "A String",
909 ],
910 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
911 # Next id: 12
912 "warningTraces": [ # Output only.
913 # A list of warnings, if such are encountered during this scan run.
914 { # Output only.
915 # Defines a warning trace message for ScanRun. Warning traces provide customers
916 # with useful information that helps make the scanning process more effective.
917 "code": "A String", # Output only.
918 # Indicates the warning code.
919 },
920 ],
921 "name": "A String", # Output only.
922 # The resource name of the ScanRun. The name follows the format of
923 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
924 # The ScanRun IDs are generated by the system.
925 "executionState": "A String", # Output only.
926 # The execution state of the ScanRun.
927 "urlsTestedCount": "A String", # Output only.
928 # The number of URLs tested during this ScanRun. If the scan is in progress,
929 # the value represents the number of URLs tested up to now. The number of
930 # URLs tested is usually larger than the number URLS crawled because
931 # typically a crawled URL is tested with multiple test payloads.
932 "progressPercent": 42, # Output only.
933 # The percentage of total completion ranging from 0 to 100.
934 # If the scan is in queue, the value is 0.
935 # If the scan is running, the value ranges from 0 to 100.
936 # If the scan is finished, the value is 100.
937 "errorTrace": { # Output only. # Output only.
938 # If result_state is an ERROR, this field provides the primary reason for
939 # scan's termination and more details, if such are available.
940 # Defines an error trace message for a ScanRun.
941 "mostCommonHttpErrorCode": 42, # Output only.
942 # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
943 # common HTTP error code, if such is available. For example, if this code is
944 # 404, the scan has encountered too many NOT_FOUND responses.
945 "code": "A String", # Output only.
946 # Indicates the error reason code.
947 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
948 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
949 # message encountered during scan configuration validation that is performed
950 # before each scan run.
951 # APIs when scan configuration validation fails. It is also reported as part of
952 # a ScanRunErrorTrace message if scan validation fails due to a scan
953 # configuration error.
954 "code": "A String", # Output only.
955 # Indicates the reason code for a configuration failure.
956 "fieldName": "A String", # Output only.
957 # Indicates the full name of the ScanConfig field that triggers this error,
958 # for example "scan_config.max_qps". This field is provided for
959 # troubleshooting purposes only and its actual value can change in the
960 # future.
961 },
962 },
963 "resultState": "A String", # Output only.
964 # The result state of the ScanRun. This field is only available after the
965 # execution state reaches "FINISHED".
966 "startTime": "A String", # Output only.
967 # The time at which the ScanRun started.
968 "endTime": "A String", # Output only.
969 # The time at which the ScanRun reached termination state - that the ScanRun
970 # is either finished or stopped by user.
971 "hasVulnerabilities": True or False, # Output only.
972 # Whether the scan run has found any vulnerabilities.
973 "urlsCrawledCount": "A String", # Output only.
974 # The number of URLs crawled during this ScanRun. If the scan is in progress,
975 # the value represents the number of URLs crawled up to now.
976 },
977 }</pre>
978</div>
979
980<div class="method">
981 <code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
982 <pre>Start a ScanRun according to the given ScanConfig.
983
984Args:
985 name: string, Required.
986The resource name of the ScanConfig to be used. The name follows the
987format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
988 body: object, The request body.
989 The object takes the form of:
990
991{ # Request for the `StartScanRun` method.
992 }
993
994 x__xgafv: string, V1 error format.
995 Allowed values
996 1 - v1 error format
997 2 - v2 error format
998
999Returns:
1000 An object of the form:
1001
1002 { # A ScanRun is a output-only resource representing an actual run of the scan.
1003 # Next id: 12
1004 "warningTraces": [ # Output only.
1005 # A list of warnings, if such are encountered during this scan run.
1006 { # Output only.
1007 # Defines a warning trace message for ScanRun. Warning traces provide customers
1008 # with useful information that helps make the scanning process more effective.
1009 "code": "A String", # Output only.
1010 # Indicates the warning code.
1011 },
1012 ],
1013 "name": "A String", # Output only.
1014 # The resource name of the ScanRun. The name follows the format of
1015 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
1016 # The ScanRun IDs are generated by the system.
1017 "executionState": "A String", # Output only.
1018 # The execution state of the ScanRun.
1019 "urlsTestedCount": "A String", # Output only.
1020 # The number of URLs tested during this ScanRun. If the scan is in progress,
1021 # the value represents the number of URLs tested up to now. The number of
1022 # URLs tested is usually larger than the number URLS crawled because
1023 # typically a crawled URL is tested with multiple test payloads.
1024 "progressPercent": 42, # Output only.
1025 # The percentage of total completion ranging from 0 to 100.
1026 # If the scan is in queue, the value is 0.
1027 # If the scan is running, the value ranges from 0 to 100.
1028 # If the scan is finished, the value is 100.
1029 "errorTrace": { # Output only. # Output only.
1030 # If result_state is an ERROR, this field provides the primary reason for
1031 # scan's termination and more details, if such are available.
1032 # Defines an error trace message for a ScanRun.
1033 "mostCommonHttpErrorCode": 42, # Output only.
1034 # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
1035 # common HTTP error code, if such is available. For example, if this code is
1036 # 404, the scan has encountered too many NOT_FOUND responses.
1037 "code": "A String", # Output only.
1038 # Indicates the error reason code.
1039 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
1040 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
1041 # message encountered during scan configuration validation that is performed
1042 # before each scan run.
1043 # APIs when scan configuration validation fails. It is also reported as part of
1044 # a ScanRunErrorTrace message if scan validation fails due to a scan
1045 # configuration error.
1046 "code": "A String", # Output only.
1047 # Indicates the reason code for a configuration failure.
1048 "fieldName": "A String", # Output only.
1049 # Indicates the full name of the ScanConfig field that triggers this error,
1050 # for example "scan_config.max_qps". This field is provided for
1051 # troubleshooting purposes only and its actual value can change in the
1052 # future.
1053 },
1054 },
1055 "resultState": "A String", # Output only.
1056 # The result state of the ScanRun. This field is only available after the
1057 # execution state reaches "FINISHED".
1058 "startTime": "A String", # Output only.
1059 # The time at which the ScanRun started.
1060 "endTime": "A String", # Output only.
1061 # The time at which the ScanRun reached termination state - that the ScanRun
1062 # is either finished or stopped by user.
1063 "hasVulnerabilities": True or False, # Output only.
1064 # Whether the scan run has found any vulnerabilities.
1065 "urlsCrawledCount": "A String", # Output only.
1066 # The number of URLs crawled during this ScanRun. If the scan is in progress,
1067 # the value represents the number of URLs crawled up to now.
1068 }</pre>
1069</div>
1070
1071</body></html>