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