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