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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 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"> 84 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 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"> 91 <code class="details" id="close">close()</code> 92 <pre>Close httplib2 connections.</pre> 93</div> 94 95<div class="method"> 96 <code class="details" id="get">get(name, x__xgafv=None)</code> 97 <pre>Gets a Finding. 98 99Args: 100 name: string, Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. (required) 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 109 { # A Finding resource represents a vulnerability instance identified during a ScanRun. 110 "body": "A String", # The body of the request that triggered the vulnerability. 111 "description": "A String", # The description of the vulnerability. 112 "finalUrl": "A String", # The URL where the browser lands when the vulnerability is detected. 113 "findingType": "A String", # The type of the Finding. 114 "frameUrl": "A String", # If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. 115 "fuzzedUrl": "A String", # The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. 116 "httpMethod": "A String", # The http method of the request that triggered the vulnerability, in uppercase. 117 "name": "A String", # The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. 118 "outdatedLibrary": { # Information reported for an outdated library. # An addon containing information about outdated libraries. 119 "learnMoreUrls": [ # URLs to learn more information about the vulnerabilities in the library. 120 "A String", 121 ], 122 "libraryName": "A String", # The name of the outdated library. 123 "version": "A String", # The version number. 124 }, 125 "reproductionUrl": "A String", # The URL containing human-readable payload that user can leverage to reproduce the vulnerability. 126 "trackingId": "A String", # The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. 127 "violatingResource": { # 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. 128 "contentType": "A String", # The MIME type of this resource. 129 "resourceUrl": "A String", # URL of this violating resource. 130 }, 131 "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # An addon containing information about vulnerable or missing HTTP headers. 132 "headers": [ # List of vulnerable headers. 133 { # Describes a HTTP Header. 134 "name": "A String", # Header name. 135 "value": "A String", # Header value. 136 }, 137 ], 138 "missingHeaders": [ # List of missing headers. 139 { # Describes a HTTP Header. 140 "name": "A String", # Header name. 141 "value": "A String", # Header value. 142 }, 143 ], 144 }, 145 "vulnerableParameters": { # Information about vulnerable request parameters. # An addon containing information about request parameters which were found to be vulnerable. 146 "parameterNames": [ # The vulnerable parameter names. 147 "A String", 148 ], 149 }, 150 "xss": { # Information reported for an XSS. # An addon containing information reported for an XSS, if any. 151 "errorMessage": "A String", # An error message generated by a javascript breakage. 152 "stackTraces": [ # Stack traces leading to the point where the XSS occurred. 153 "A String", 154 ], 155 }, 156}</pre> 157</div> 158 159<div class="method"> 160 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 161 <pre>List Findings under a given ScanRun. 162 163Args: 164 parent: string, Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required) 165 filter: string, Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. 166 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. 167 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. 168 x__xgafv: string, V1 error format. 169 Allowed values 170 1 - v1 error format 171 2 - v2 error format 172 173Returns: 174 An object of the form: 175 176 { # Response for the `ListFindings` method. 177 "findings": [ # The list of Findings returned. 178 { # A Finding resource represents a vulnerability instance identified during a ScanRun. 179 "body": "A String", # The body of the request that triggered the vulnerability. 180 "description": "A String", # The description of the vulnerability. 181 "finalUrl": "A String", # The URL where the browser lands when the vulnerability is detected. 182 "findingType": "A String", # The type of the Finding. 183 "frameUrl": "A String", # If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. 184 "fuzzedUrl": "A String", # The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. 185 "httpMethod": "A String", # The http method of the request that triggered the vulnerability, in uppercase. 186 "name": "A String", # The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. 187 "outdatedLibrary": { # Information reported for an outdated library. # An addon containing information about outdated libraries. 188 "learnMoreUrls": [ # URLs to learn more information about the vulnerabilities in the library. 189 "A String", 190 ], 191 "libraryName": "A String", # The name of the outdated library. 192 "version": "A String", # The version number. 193 }, 194 "reproductionUrl": "A String", # The URL containing human-readable payload that user can leverage to reproduce the vulnerability. 195 "trackingId": "A String", # The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. 196 "violatingResource": { # 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. 197 "contentType": "A String", # The MIME type of this resource. 198 "resourceUrl": "A String", # URL of this violating resource. 199 }, 200 "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # An addon containing information about vulnerable or missing HTTP headers. 201 "headers": [ # List of vulnerable headers. 202 { # Describes a HTTP Header. 203 "name": "A String", # Header name. 204 "value": "A String", # Header value. 205 }, 206 ], 207 "missingHeaders": [ # List of missing headers. 208 { # Describes a HTTP Header. 209 "name": "A String", # Header name. 210 "value": "A String", # Header value. 211 }, 212 ], 213 }, 214 "vulnerableParameters": { # Information about vulnerable request parameters. # An addon containing information about request parameters which were found to be vulnerable. 215 "parameterNames": [ # The vulnerable parameter names. 216 "A String", 217 ], 218 }, 219 "xss": { # Information reported for an XSS. # An addon containing information reported for an XSS, if any. 220 "errorMessage": "A String", # An error message generated by a javascript breakage. 221 "stackTraces": [ # Stack traces leading to the point where the XSS occurred. 222 "A String", 223 ], 224 }, 225 }, 226 ], 227 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 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: 240 A request object that you can call 'execute()' on to request the next 241 page. Returns None if there are no more items in the collection. 242 </pre> 243</div> 244 245</body></html>