Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / websecurityscanner_v1alpha.projects.scanConfigs.html
blob: 023997dda6d37c44445f373cf3bc19f84132190e [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_v1alpha.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1alpha.projects.html">projects</a> . <a href="websecurityscanner_v1alpha.projects.scanConfigs.html">scanConfigs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html">scanRuns()</a></code>
79</p>
80<p class="firstline">Returns the scanRuns Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]83 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]98 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99<p class="firstline">Updates a ScanConfig. This method support partial update of a ScanConfig.</p>
100<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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 <pre>Creates a new ScanConfig.
107
108Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]109 parent: string, Required. The parent resource name where the scan is created, which should be a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110project resource name in the format 'projects/{projectId}'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 The object takes the form of:
113
114{ # A ScanConfig resource contains the configurations to launch a scan.
115 # next id: 12
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]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. The user provided display name of the ScanConfig.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
122 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
123 # generated by the system.
124 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
125 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
126 # refreshed by the server after each run. If unspecified, it will default
127 # to current server time, which means the scan will be scheduled to start
128 # immediately.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]129 "intervalDurationDays": 42, # Required. The duration of time between executions in days.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]131 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
132 # used as a default.
133 "A String",
134 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 "blacklistPatterns": [ # The blacklist URL patterns as described in
136 # https://cloud.google.com/security-scanner/docs/excluded-urls
137 "A String",
138 ],
139 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
140 # authentication configuration during scanning.
141 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]142 "username": "A String", # Required. The user name of the Google account.
143 "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 # and not returned in any response nor included in audit logs.
145 },
146 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]147 "username": "A String", # Required. The user name of the custom account.
148 "loginUrl": "A String", # Required. The login form URL of the website.
149 "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 # and not returned in any response nor included in audit logs.
151 },
152 },
153 "userAgent": "A String", # The user agent used during scanning.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]154 "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 "A String",
156 ],
157 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]158 "name": "A String", # The resource name of the ScanRun. The name follows the format of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
160 # The ScanRun IDs are generated by the system.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]161 "executionState": "A String", # The execution state of the ScanRun.
162 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 # the value represents the number of URLs tested up to now. The number of
164 # URLs tested is usually larger than the number URLS crawled because
165 # typically a crawled URL is tested with multiple test payloads.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]166 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167 # If the scan is in queue, the value is 0.
168 # If the scan is running, the value ranges from 0 to 100.
169 # If the scan is finished, the value is 100.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]170 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 # the value represents the number of URLs crawled up to now.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]172 "startTime": "A String", # The time at which the ScanRun started.
173 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
174 # is either finished or stopped by user.
175 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
176 "resultState": "A String", # The result state of the ScanRun. This field is only available after the
177 # execution state reaches "FINISHED".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178 },
179}
180
181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
185
186Returns:
187 An object of the form:
188
189 { # A ScanConfig resource contains the configurations to launch a scan.
190 # next id: 12
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]191 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
192 # inclusively. If the field is unspecified or its value is set 0, server will
193 # default to 15. Other values outside of [5, 20] range will be rejected with
194 # INVALID_ARGUMENT error.
195 "displayName": "A String", # Required. The user provided display name of the ScanConfig.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
197 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
198 # generated by the system.
199 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
200 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
201 # refreshed by the server after each run. If unspecified, it will default
202 # to current server time, which means the scan will be scheduled to start
203 # immediately.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]204 "intervalDurationDays": 42, # Required. The duration of time between executions in days.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]206 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
207 # used as a default.
208 "A String",
209 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210 "blacklistPatterns": [ # The blacklist URL patterns as described in
211 # https://cloud.google.com/security-scanner/docs/excluded-urls
212 "A String",
213 ],
214 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
215 # authentication configuration during scanning.
216 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]217 "username": "A String", # Required. The user name of the Google account.
218 "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219 # and not returned in any response nor included in audit logs.
220 },
221 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]222 "username": "A String", # Required. The user name of the custom account.
223 "loginUrl": "A String", # Required. The login form URL of the website.
224 "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]225 # and not returned in any response nor included in audit logs.
226 },
227 },
228 "userAgent": "A String", # The user agent used during scanning.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]229 "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230 "A String",
231 ],
232 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]233 "name": "A String", # The resource name of the ScanRun. The name follows the format of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
235 # The ScanRun IDs are generated by the system.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]236 "executionState": "A String", # The execution state of the ScanRun.
237 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]238 # the value represents the number of URLs tested up to now. The number of
239 # URLs tested is usually larger than the number URLS crawled because
240 # typically a crawled URL is tested with multiple test payloads.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]241 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]242 # If the scan is in queue, the value is 0.
243 # If the scan is running, the value ranges from 0 to 100.
244 # If the scan is finished, the value is 100.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]245 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 # the value represents the number of URLs crawled up to now.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]247 "startTime": "A String", # The time at which the ScanRun started.
248 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
249 # is either finished or stopped by user.
250 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
251 "resultState": "A String", # The result state of the ScanRun. This field is only available after the
252 # execution state reaches "FINISHED".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]253 },
254 }</pre>
255</div>
256
257<div class="method">
258 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
259 <pre>Deletes an existing ScanConfig and its child resources.
260
261Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]262 name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
264 x__xgafv: string, V1 error format.
265 Allowed values
266 1 - v1 error format
267 2 - v2 error format
268
269Returns:
270 An object of the form:
271
272 { # A generic empty message that you can re-use to avoid defining duplicated
273 # empty messages in your APIs. A typical example is to use it as the request
274 # or the response type of an API method. For instance:
275 #
276 # service Foo {
277 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
278 # }
279 #
280 # The JSON representation for `Empty` is empty JSON object `{}`.
281 }</pre>
282</div>
283
284<div class="method">
285 <code class="details" id="get">get(name, x__xgafv=None)</code>
286 <pre>Gets a ScanConfig.
287
288Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]289 name: string, Required. The resource name of the ScanConfig to be returned. The name follows the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]290format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
291 x__xgafv: string, V1 error format.
292 Allowed values
293 1 - v1 error format
294 2 - v2 error format
295
296Returns:
297 An object of the form:
298
299 { # A ScanConfig resource contains the configurations to launch a scan.
300 # next id: 12
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]301 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
302 # inclusively. If the field is unspecified or its value is set 0, server will
303 # default to 15. Other values outside of [5, 20] range will be rejected with
304 # INVALID_ARGUMENT error.
305 "displayName": "A String", # Required. The user provided display name of the ScanConfig.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]306 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
307 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
308 # generated by the system.
309 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
310 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
311 # refreshed by the server after each run. If unspecified, it will default
312 # to current server time, which means the scan will be scheduled to start
313 # immediately.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]314 "intervalDurationDays": 42, # Required. The duration of time between executions in days.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]315 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]316 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
317 # used as a default.
318 "A String",
319 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 "blacklistPatterns": [ # The blacklist URL patterns as described in
321 # https://cloud.google.com/security-scanner/docs/excluded-urls
322 "A String",
323 ],
324 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
325 # authentication configuration during scanning.
326 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]327 "username": "A String", # Required. The user name of the Google account.
328 "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]329 # and not returned in any response nor included in audit logs.
330 },
331 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]332 "username": "A String", # Required. The user name of the custom account.
333 "loginUrl": "A String", # Required. The login form URL of the website.
334 "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]335 # and not returned in any response nor included in audit logs.
336 },
337 },
338 "userAgent": "A String", # The user agent used during scanning.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]339 "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]340 "A String",
341 ],
342 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]343 "name": "A String", # The resource name of the ScanRun. The name follows the format of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]344 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
345 # The ScanRun IDs are generated by the system.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]346 "executionState": "A String", # The execution state of the ScanRun.
347 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]348 # the value represents the number of URLs tested up to now. The number of
349 # URLs tested is usually larger than the number URLS crawled because
350 # typically a crawled URL is tested with multiple test payloads.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]351 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]352 # If the scan is in queue, the value is 0.
353 # If the scan is running, the value ranges from 0 to 100.
354 # If the scan is finished, the value is 100.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]355 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]356 # the value represents the number of URLs crawled up to now.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]357 "startTime": "A String", # The time at which the ScanRun started.
358 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
359 # is either finished or stopped by user.
360 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
361 "resultState": "A String", # The result state of the ScanRun. This field is only available after the
362 # execution state reaches "FINISHED".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]363 },
364 }</pre>
365</div>
366
367<div class="method">
368 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
369 <pre>Lists ScanConfigs under a given project.
370
371Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]372 parent: string, Required. The parent resource name, which should be a project resource name in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]373format 'projects/{projectId}'. (required)
374 pageToken: string, A token identifying a page of results to be returned. This should be a
375`next_page_token` value returned from a previous List request.
376If unspecified, the first page of results is returned.
377 x__xgafv: string, V1 error format.
378 Allowed values
379 1 - v1 error format
380 2 - v2 error format
381 pageSize: integer, The maximum number of ScanConfigs to return, can be limited by server.
382If not specified or not positive, the implementation will select a
383reasonable value.
384
385Returns:
386 An object of the form:
387
388 { # Response for the `ListScanConfigs` method.
389 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
390 # more results in the list.
391 "scanConfigs": [ # The list of ScanConfigs returned.
392 { # A ScanConfig resource contains the configurations to launch a scan.
393 # next id: 12
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]394 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
395 # inclusively. If the field is unspecified or its value is set 0, server will
396 # default to 15. Other values outside of [5, 20] range will be rejected with
397 # INVALID_ARGUMENT error.
398 "displayName": "A String", # Required. The user provided display name of the ScanConfig.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
400 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
401 # generated by the system.
402 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
403 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
404 # refreshed by the server after each run. If unspecified, it will default
405 # to current server time, which means the scan will be scheduled to start
406 # immediately.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]407 "intervalDurationDays": 42, # Required. The duration of time between executions in days.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]408 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]409 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
410 # used as a default.
411 "A String",
412 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]413 "blacklistPatterns": [ # The blacklist URL patterns as described in
414 # https://cloud.google.com/security-scanner/docs/excluded-urls
415 "A String",
416 ],
417 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
418 # authentication configuration during scanning.
419 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]420 "username": "A String", # Required. The user name of the Google account.
421 "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]422 # and not returned in any response nor included in audit logs.
423 },
424 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]425 "username": "A String", # Required. The user name of the custom account.
426 "loginUrl": "A String", # Required. The login form URL of the website.
427 "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]428 # and not returned in any response nor included in audit logs.
429 },
430 },
431 "userAgent": "A String", # The user agent used during scanning.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]432 "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]433 "A String",
434 ],
435 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]436 "name": "A String", # The resource name of the ScanRun. The name follows the format of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]437 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
438 # The ScanRun IDs are generated by the system.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]439 "executionState": "A String", # The execution state of the ScanRun.
440 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]441 # the value represents the number of URLs tested up to now. The number of
442 # URLs tested is usually larger than the number URLS crawled because
443 # typically a crawled URL is tested with multiple test payloads.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]444 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]445 # If the scan is in queue, the value is 0.
446 # If the scan is running, the value ranges from 0 to 100.
447 # If the scan is finished, the value is 100.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]448 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]449 # the value represents the number of URLs crawled up to now.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]450 "startTime": "A String", # The time at which the ScanRun started.
451 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
452 # is either finished or stopped by user.
453 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
454 "resultState": "A String", # The result state of the ScanRun. This field is only available after the
455 # execution state reaches "FINISHED".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]456 },
457 },
458 ],
459 }</pre>
460</div>
461
462<div class="method">
463 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
464 <pre>Retrieves the next page of results.
465
466Args:
467 previous_request: The request for the previous page. (required)
468 previous_response: The response from the request for the previous page. (required)
469
470Returns:
471 A request object that you can call 'execute()' on to request the next
472 page. Returns None if there are no more items in the collection.
473 </pre>
474</div>
475
476<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]477 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]478 <pre>Updates a ScanConfig. This method support partial update of a ScanConfig.
479
480Args:
481 name: string, The resource name of the ScanConfig. The name follows the format of
482'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
483generated by the system. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]484 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]485 The object takes the form of:
486
487{ # A ScanConfig resource contains the configurations to launch a scan.
488 # next id: 12
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]489 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
490 # inclusively. If the field is unspecified or its value is set 0, server will
491 # default to 15. Other values outside of [5, 20] range will be rejected with
492 # INVALID_ARGUMENT error.
493 "displayName": "A String", # Required. The user provided display name of the ScanConfig.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]494 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
495 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
496 # generated by the system.
497 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
498 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
499 # refreshed by the server after each run. If unspecified, it will default
500 # to current server time, which means the scan will be scheduled to start
501 # immediately.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]502 "intervalDurationDays": 42, # Required. The duration of time between executions in days.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]503 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]504 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
505 # used as a default.
506 "A String",
507 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]508 "blacklistPatterns": [ # The blacklist URL patterns as described in
509 # https://cloud.google.com/security-scanner/docs/excluded-urls
510 "A String",
511 ],
512 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
513 # authentication configuration during scanning.
514 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]515 "username": "A String", # Required. The user name of the Google account.
516 "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]517 # and not returned in any response nor included in audit logs.
518 },
519 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]520 "username": "A String", # Required. The user name of the custom account.
521 "loginUrl": "A String", # Required. The login form URL of the website.
522 "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]523 # and not returned in any response nor included in audit logs.
524 },
525 },
526 "userAgent": "A String", # The user agent used during scanning.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]527 "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]528 "A String",
529 ],
530 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]531 "name": "A String", # The resource name of the ScanRun. The name follows the format of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]532 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
533 # The ScanRun IDs are generated by the system.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]534 "executionState": "A String", # The execution state of the ScanRun.
535 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]536 # the value represents the number of URLs tested up to now. The number of
537 # URLs tested is usually larger than the number URLS crawled because
538 # typically a crawled URL is tested with multiple test payloads.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]539 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]540 # If the scan is in queue, the value is 0.
541 # If the scan is running, the value ranges from 0 to 100.
542 # If the scan is finished, the value is 100.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]543 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]544 # the value represents the number of URLs crawled up to now.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]545 "startTime": "A String", # The time at which the ScanRun started.
546 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
547 # is either finished or stopped by user.
548 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
549 "resultState": "A String", # The result state of the ScanRun. This field is only available after the
550 # execution state reaches "FINISHED".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]551 },
552}
553
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]554 updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]555see
556https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
557 x__xgafv: string, V1 error format.
558 Allowed values
559 1 - v1 error format
560 2 - v2 error format
561
562Returns:
563 An object of the form:
564
565 { # A ScanConfig resource contains the configurations to launch a scan.
566 # next id: 12
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]567 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
568 # inclusively. If the field is unspecified or its value is set 0, server will
569 # default to 15. Other values outside of [5, 20] range will be rejected with
570 # INVALID_ARGUMENT error.
571 "displayName": "A String", # Required. The user provided display name of the ScanConfig.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]572 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
573 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
574 # generated by the system.
575 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
576 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
577 # refreshed by the server after each run. If unspecified, it will default
578 # to current server time, which means the scan will be scheduled to start
579 # immediately.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]580 "intervalDurationDays": 42, # Required. The duration of time between executions in days.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]581 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]582 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
583 # used as a default.
584 "A String",
585 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]586 "blacklistPatterns": [ # The blacklist URL patterns as described in
587 # https://cloud.google.com/security-scanner/docs/excluded-urls
588 "A String",
589 ],
590 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
591 # authentication configuration during scanning.
592 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]593 "username": "A String", # Required. The user name of the Google account.
594 "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]595 # and not returned in any response nor included in audit logs.
596 },
597 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]598 "username": "A String", # Required. The user name of the custom account.
599 "loginUrl": "A String", # Required. The login form URL of the website.
600 "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]601 # and not returned in any response nor included in audit logs.
602 },
603 },
604 "userAgent": "A String", # The user agent used during scanning.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]605 "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]606 "A String",
607 ],
608 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]609 "name": "A String", # The resource name of the ScanRun. The name follows the format of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]610 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
611 # The ScanRun IDs are generated by the system.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]612 "executionState": "A String", # The execution state of the ScanRun.
613 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]614 # the value represents the number of URLs tested up to now. The number of
615 # URLs tested is usually larger than the number URLS crawled because
616 # typically a crawled URL is tested with multiple test payloads.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]617 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]618 # If the scan is in queue, the value is 0.
619 # If the scan is running, the value ranges from 0 to 100.
620 # If the scan is finished, the value is 100.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]621 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]622 # the value represents the number of URLs crawled up to now.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]623 "startTime": "A String", # The time at which the ScanRun started.
624 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
625 # is either finished or stopped by user.
626 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
627 "resultState": "A String", # The result state of the ScanRun. This field is only available after the
628 # execution state reaches "FINISHED".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]629 },
630 }</pre>
631</div>
632
633<div class="method">
634 <code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
635 <pre>Start a ScanRun according to the given ScanConfig.
636
637Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]638 name: string, Required. The resource name of the ScanConfig to be used. The name follows the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]639format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
640 body: object, The request body.
641 The object takes the form of:
642
643{ # Request for the `StartScanRun` method.
644 }
645
646 x__xgafv: string, V1 error format.
647 Allowed values
648 1 - v1 error format
649 2 - v2 error format
650
651Returns:
652 An object of the form:
653
654 { # A ScanRun is a output-only resource representing an actual run of the scan.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]655 "name": "A String", # The resource name of the ScanRun. The name follows the format of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]656 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
657 # The ScanRun IDs are generated by the system.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]658 "executionState": "A String", # The execution state of the ScanRun.
659 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]660 # the value represents the number of URLs tested up to now. The number of
661 # URLs tested is usually larger than the number URLS crawled because
662 # typically a crawled URL is tested with multiple test payloads.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]663 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]664 # If the scan is in queue, the value is 0.
665 # If the scan is running, the value ranges from 0 to 100.
666 # If the scan is finished, the value is 100.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]667 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]668 # the value represents the number of URLs crawled up to now.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]669 "startTime": "A String", # The time at which the ScanRun started.
670 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
671 # is either finished or stopped by user.
672 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
673 "resultState": "A String", # The result state of the ScanRun. This field is only available after the
674 # execution state reaches "FINISHED".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]675 }</pre>
676</div>
677
678</body></html>