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