Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / websecurityscanner_v1beta.projects.scanConfigs.scanRuns.findings.html
blob: e28efad42462839345f1765b709428e4c4d2f7b2 [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> . <a href="websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html">scanRuns</a> . <a href="websecurityscanner_v1beta.projects.scanConfigs.scanRuns.findings.html">findings</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a Finding.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">List Findings under a given ScanRun.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(name, x__xgafv=None)</code>
89 <pre>Gets a Finding.
90
91Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]92 name: string, Required. The resource name of the Finding to be returned. The name follows the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93format of
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]94&#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}&#x27;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
99
100Returns:
101 An object of the form:
102
103 { # A Finding resource represents a vulnerability instance identified during a
104 # ScanRun.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 &quot;httpMethod&quot;: &quot;A String&quot;, # The http method of the request that triggered the vulnerability, in
106 # uppercase.
107 &quot;vulnerableParameters&quot;: { # Information about vulnerable request parameters. # An addon containing information about request parameters which were found
108 # to be vulnerable.
109 &quot;parameterNames&quot;: [ # The vulnerable parameter names.
110 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111 ],
112 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Finding. The name follows the format of
114 # &#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}&#x27;.
115 # The finding IDs are generated by the system.
116 &quot;vulnerableHeaders&quot;: { # Information about vulnerable or missing HTTP Headers. # An addon containing information about vulnerable or missing HTTP headers.
117 &quot;headers&quot;: [ # List of vulnerable headers.
118 { # Describes a HTTP Header.
119 &quot;value&quot;: &quot;A String&quot;, # Header value.
120 &quot;name&quot;: &quot;A String&quot;, # Header name.
121 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &quot;missingHeaders&quot;: [ # List of missing headers.
124 { # Describes a HTTP Header.
125 &quot;value&quot;: &quot;A String&quot;, # Header value.
126 &quot;name&quot;: &quot;A String&quot;, # Header name.
127 },
128 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 &quot;findingType&quot;: &quot;A String&quot;, # The type of the Finding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 # Detailed and up-to-date information on findings can be found here:
132 # https://cloud.google.com/security-scanner/docs/scan-result-details
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 &quot;outdatedLibrary&quot;: { # Information reported for an outdated library. # An addon containing information about outdated libraries.
134 &quot;version&quot;: &quot;A String&quot;, # The version number.
135 &quot;libraryName&quot;: &quot;A String&quot;, # The name of the outdated library.
136 &quot;learnMoreUrls&quot;: [ # URLs to learn more information about the vulnerabilities in the library.
137 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 ],
139 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 &quot;violatingResource&quot;: { # Information regarding any resource causing the vulnerability such # An addon containing detailed information regarding any resource causing the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]141 # vulnerability such as JavaScript sources, image, audio files, etc.
142 # as JavaScript sources, image, audio files, etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 &quot;resourceUrl&quot;: &quot;A String&quot;, # URL of this violating resource.
144 &quot;contentType&quot;: &quot;A String&quot;, # The MIME type of this resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]145 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]146 &quot;xss&quot;: { # Information reported for an XSS. # An addon containing information reported for an XSS, if any.
147 &quot;errorMessage&quot;: &quot;A String&quot;, # An error message generated by a javascript breakage.
148 &quot;stackTraces&quot;: [ # Stack traces leading to the point where the XSS occurred.
149 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 ],
151 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]152 &quot;severity&quot;: &quot;A String&quot;, # The severity level of the reported vulnerability.
153 &quot;finalUrl&quot;: &quot;A String&quot;, # The URL where the browser lands when the vulnerability is detected.
154 &quot;body&quot;: &quot;A String&quot;, # The body of the request that triggered the vulnerability.
155 &quot;reproductionUrl&quot;: &quot;A String&quot;, # The URL containing human-readable payload that user can leverage to
156 # reproduce the vulnerability.
157 &quot;form&quot;: { # ! Information about a vulnerability with an HTML. # An addon containing information reported for a vulnerability with an HTML
158 # form, if any.
159 &quot;actionUri&quot;: &quot;A String&quot;, # ! The URI where to send the form when it&#x27;s submitted.
160 &quot;fields&quot;: [ # ! The names of form fields related to the vulnerability.
161 &quot;A String&quot;,
162 ],
163 },
164 &quot;frameUrl&quot;: &quot;A String&quot;, # If the vulnerability was originated from nested IFrame, the immediate
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]165 # parent IFrame is reported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]166 &quot;fuzzedUrl&quot;: &quot;A String&quot;, # The URL produced by the server-side fuzzer and used in the request that
167 # triggered the vulnerability.
168 &quot;description&quot;: &quot;A String&quot;, # The description of the vulnerability.
169 &quot;trackingId&quot;: &quot;A String&quot;, # The tracking ID uniquely identifies a vulnerability instance across
170 # multiple ScanRuns.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 }</pre>
172</div>
173
174<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 <code class="details" id="list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 <pre>List Findings under a given ScanRun.
177
178Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]179 parent: string, Required. The parent resource name, which should be a scan run resource name in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]181&#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}&#x27;. (required)
182 pageSize: integer, The maximum number of Findings to return, can be limited by server.
183If not specified or not positive, the implementation will select a
184reasonable value.
185 filter: string, Required. The filter expression. The expression must be in the format: &lt;field&gt;
186&lt;operator&gt; &lt;value&gt;.
187Supported field: &#x27;finding_type&#x27;.
188Supported operator: &#x27;=&#x27;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 pageToken: string, A token identifying a page of results to be returned. This should be a
190`next_page_token` value returned from a previous List request.
191If unspecified, the first page of results is returned.
192 x__xgafv: string, V1 error format.
193 Allowed values
194 1 - v1 error format
195 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196
197Returns:
198 An object of the form:
199
200 { # Response for the `ListFindings` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]201 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202 # more results in the list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]203 &quot;findings&quot;: [ # The list of Findings returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]204 { # A Finding resource represents a vulnerability instance identified during a
205 # ScanRun.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 &quot;httpMethod&quot;: &quot;A String&quot;, # The http method of the request that triggered the vulnerability, in
207 # uppercase.
208 &quot;vulnerableParameters&quot;: { # Information about vulnerable request parameters. # An addon containing information about request parameters which were found
209 # to be vulnerable.
210 &quot;parameterNames&quot;: [ # The vulnerable parameter names.
211 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 ],
213 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]214 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Finding. The name follows the format of
215 # &#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}&#x27;.
216 # The finding IDs are generated by the system.
217 &quot;vulnerableHeaders&quot;: { # Information about vulnerable or missing HTTP Headers. # An addon containing information about vulnerable or missing HTTP headers.
218 &quot;headers&quot;: [ # List of vulnerable headers.
219 { # Describes a HTTP Header.
220 &quot;value&quot;: &quot;A String&quot;, # Header value.
221 &quot;name&quot;: &quot;A String&quot;, # Header name.
222 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224 &quot;missingHeaders&quot;: [ # List of missing headers.
225 { # Describes a HTTP Header.
226 &quot;value&quot;: &quot;A String&quot;, # Header value.
227 &quot;name&quot;: &quot;A String&quot;, # Header name.
228 },
229 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]231 &quot;findingType&quot;: &quot;A String&quot;, # The type of the Finding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232 # Detailed and up-to-date information on findings can be found here:
233 # https://cloud.google.com/security-scanner/docs/scan-result-details
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]234 &quot;outdatedLibrary&quot;: { # Information reported for an outdated library. # An addon containing information about outdated libraries.
235 &quot;version&quot;: &quot;A String&quot;, # The version number.
236 &quot;libraryName&quot;: &quot;A String&quot;, # The name of the outdated library.
237 &quot;learnMoreUrls&quot;: [ # URLs to learn more information about the vulnerabilities in the library.
238 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]239 ],
240 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]241 &quot;violatingResource&quot;: { # Information regarding any resource causing the vulnerability such # An addon containing detailed information regarding any resource causing the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]242 # vulnerability such as JavaScript sources, image, audio files, etc.
243 # as JavaScript sources, image, audio files, etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]244 &quot;resourceUrl&quot;: &quot;A String&quot;, # URL of this violating resource.
245 &quot;contentType&quot;: &quot;A String&quot;, # The MIME type of this resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]246 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]247 &quot;xss&quot;: { # Information reported for an XSS. # An addon containing information reported for an XSS, if any.
248 &quot;errorMessage&quot;: &quot;A String&quot;, # An error message generated by a javascript breakage.
249 &quot;stackTraces&quot;: [ # Stack traces leading to the point where the XSS occurred.
250 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251 ],
252 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]253 &quot;severity&quot;: &quot;A String&quot;, # The severity level of the reported vulnerability.
254 &quot;finalUrl&quot;: &quot;A String&quot;, # The URL where the browser lands when the vulnerability is detected.
255 &quot;body&quot;: &quot;A String&quot;, # The body of the request that triggered the vulnerability.
256 &quot;reproductionUrl&quot;: &quot;A String&quot;, # The URL containing human-readable payload that user can leverage to
257 # reproduce the vulnerability.
258 &quot;form&quot;: { # ! Information about a vulnerability with an HTML. # An addon containing information reported for a vulnerability with an HTML
259 # form, if any.
260 &quot;actionUri&quot;: &quot;A String&quot;, # ! The URI where to send the form when it&#x27;s submitted.
261 &quot;fields&quot;: [ # ! The names of form fields related to the vulnerability.
262 &quot;A String&quot;,
263 ],
264 },
265 &quot;frameUrl&quot;: &quot;A String&quot;, # If the vulnerability was originated from nested IFrame, the immediate
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]266 # parent IFrame is reported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]267 &quot;fuzzedUrl&quot;: &quot;A String&quot;, # The URL produced by the server-side fuzzer and used in the request that
268 # triggered the vulnerability.
269 &quot;description&quot;: &quot;A String&quot;, # The description of the vulnerability.
270 &quot;trackingId&quot;: &quot;A String&quot;, # The tracking ID uniquely identifies a vulnerability instance across
271 # multiple ScanRuns.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]272 },
273 ],
274 }</pre>
275</div>
276
277<div class="method">
278 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
279 <pre>Retrieves the next page of results.
280
281Args:
282 previous_request: The request for the previous page. (required)
283 previous_response: The response from the request for the previous page. (required)
284
285Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]286 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]287 page. Returns None if there are no more items in the collection.
288 </pre>
289</div>
290
291</body></html>