| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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_v1.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1.projects.html">projects</a> . <a href="websecurityscanner_v1.projects.scanConfigs.html">scanConfigs</a> . <a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.html">scanRuns</a> . <a href="websecurityscanner_v1.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 Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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 | |
| 91 | Args: |
| 92 | name: string, Required. The resource name of the Finding to be returned. The name follows the |
| 93 | format 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 | |
| 100 | Returns: |
| 101 | An object of the form: |
| 102 | |
| 103 | { # A Finding resource represents a vulnerability instance identified during a |
| 104 | # ScanRun. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 105 | "outdatedLibrary": { # Information reported for an outdated library. # Output only. An addon containing information about outdated libraries. |
| 106 | "libraryName": "A String", # The name of the outdated library. |
| 107 | "version": "A String", # The version number. |
| 108 | "learnMoreUrls": [ # URLs to learn more information about the vulnerabilities in the library. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 109 | "A String", |
| 110 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 111 | }, |
| 112 | "findingType": "A String", # Output only. The type of the Finding. |
| 113 | # Detailed and up-to-date information on findings can be found here: |
| 114 | # https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 115 | "name": "A String", # Output only. The resource name of the Finding. The name follows the format of |
| 116 | # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. |
| 117 | # The finding IDs are generated by the system. |
| 118 | "trackingId": "A String", # Output only. The tracking ID uniquely identifies a vulnerability instance across |
| 119 | # multiple ScanRuns. |
| 120 | "body": "A String", # Output only. The body of the request that triggered the vulnerability. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 121 | "vulnerableParameters": { # Information about vulnerable request parameters. # Output only. An addon containing information about request parameters which were found |
| 122 | # to be vulnerable. |
| 123 | "parameterNames": [ # The vulnerable parameter names. |
| 124 | "A String", |
| 125 | ], |
| 126 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 127 | "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # Output only. An addon containing information about vulnerable or missing HTTP headers. |
| 128 | "missingHeaders": [ # List of missing headers. |
| 129 | { # Describes a HTTP Header. |
| 130 | "name": "A String", # Header name. |
| 131 | "value": "A String", # Header value. |
| 132 | }, |
| 133 | ], |
| 134 | "headers": [ # List of vulnerable headers. |
| 135 | { # Describes a HTTP Header. |
| 136 | "name": "A String", # Header name. |
| 137 | "value": "A String", # Header value. |
| 138 | }, |
| 139 | ], |
| 140 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 141 | "violatingResource": { # Information regarding any resource causing the vulnerability such # Output only. An addon containing detailed information regarding any resource causing the |
| 142 | # vulnerability such as JavaScript sources, image, audio files, etc. |
| 143 | # as JavaScript sources, image, audio files, etc. |
| 144 | "resourceUrl": "A String", # URL of this violating resource. |
| 145 | "contentType": "A String", # The MIME type of this resource. |
| 146 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 147 | "severity": "A String", # Output only. The severity level of the reported vulnerability. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 148 | "fuzzedUrl": "A String", # Output only. The URL produced by the server-side fuzzer and used in the request that |
| 149 | # triggered the vulnerability. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 150 | "description": "A String", # Output only. The description of the vulnerability. |
| 151 | "xss": { # Information reported for an XSS. # Output only. An addon containing information reported for an XSS, if any. |
| 152 | "stackTraces": [ # Stack traces leading to the point where the XSS occurred. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 153 | "A String", |
| 154 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 155 | "attackVector": "A String", # The attack vector of the payload triggering this XSS. |
| 156 | "errorMessage": "A String", # An error message generated by a javascript breakage. |
| 157 | "storedXssSeedingUrl": "A String", # The reproduction url for the seeding POST request of a Stored XSS. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 158 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 159 | "form": { # ! Information about a vulnerability with an HTML. # Output only. An addon containing information reported for a vulnerability with an HTML |
| 160 | # form, if any. |
| 161 | "fields": [ # ! The names of form fields related to the vulnerability. |
| 162 | "A String", |
| 163 | ], |
| 164 | "actionUri": "A String", # ! The URI where to send the form when it's submitted. |
| 165 | }, |
| 166 | "httpMethod": "A String", # Output only. The http method of the request that triggered the vulnerability, in |
| 167 | # uppercase. |
| 168 | "finalUrl": "A String", # Output only. The URL where the browser lands when the vulnerability is detected. |
| 169 | "frameUrl": "A String", # Output only. If the vulnerability was originated from nested IFrame, the immediate |
| 170 | # parent IFrame is reported. |
| 171 | "reproductionUrl": "A String", # Output only. The URL containing human-readable payload that user can leverage to |
| 172 | # reproduce the vulnerability. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 173 | }</pre> |
| 174 | </div> |
| 175 | |
| 176 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 177 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 178 | <pre>List Findings under a given ScanRun. |
| 179 | |
| 180 | Args: |
| 181 | parent: string, Required. The parent resource name, which should be a scan run resource name in the |
| 182 | format |
| 183 | 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 184 | pageToken: string, A token identifying a page of results to be returned. This should be a |
| 185 | `next_page_token` value returned from a previous List request. |
| 186 | If unspecified, the first page of results is returned. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 187 | pageSize: integer, The maximum number of Findings to return, can be limited by server. |
| 188 | If not specified or not positive, the implementation will select a |
| 189 | reasonable value. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 190 | filter: string, The filter expression. The expression must be in the format: <field> |
| 191 | <operator> <value>. |
| 192 | Supported field: 'finding_type'. |
| 193 | Supported operator: '='. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 194 | x__xgafv: string, V1 error format. |
| 195 | Allowed values |
| 196 | 1 - v1 error format |
| 197 | 2 - v2 error format |
| 198 | |
| 199 | Returns: |
| 200 | An object of the form: |
| 201 | |
| 202 | { # Response for the `ListFindings` method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 203 | "findings": [ # The list of Findings returned. |
| 204 | { # A Finding resource represents a vulnerability instance identified during a |
| 205 | # ScanRun. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 206 | "outdatedLibrary": { # Information reported for an outdated library. # Output only. An addon containing information about outdated libraries. |
| 207 | "libraryName": "A String", # The name of the outdated library. |
| 208 | "version": "A String", # The version number. |
| 209 | "learnMoreUrls": [ # URLs to learn more information about the vulnerabilities in the library. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 210 | "A String", |
| 211 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 212 | }, |
| 213 | "findingType": "A String", # Output only. The type of the Finding. |
| 214 | # Detailed and up-to-date information on findings can be found here: |
| 215 | # https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 216 | "name": "A String", # Output only. The resource name of the Finding. The name follows the format of |
| 217 | # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. |
| 218 | # The finding IDs are generated by the system. |
| 219 | "trackingId": "A String", # Output only. The tracking ID uniquely identifies a vulnerability instance across |
| 220 | # multiple ScanRuns. |
| 221 | "body": "A String", # Output only. The body of the request that triggered the vulnerability. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 222 | "vulnerableParameters": { # Information about vulnerable request parameters. # Output only. An addon containing information about request parameters which were found |
| 223 | # to be vulnerable. |
| 224 | "parameterNames": [ # The vulnerable parameter names. |
| 225 | "A String", |
| 226 | ], |
| 227 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 228 | "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # Output only. An addon containing information about vulnerable or missing HTTP headers. |
| 229 | "missingHeaders": [ # List of missing headers. |
| 230 | { # Describes a HTTP Header. |
| 231 | "name": "A String", # Header name. |
| 232 | "value": "A String", # Header value. |
| 233 | }, |
| 234 | ], |
| 235 | "headers": [ # List of vulnerable headers. |
| 236 | { # Describes a HTTP Header. |
| 237 | "name": "A String", # Header name. |
| 238 | "value": "A String", # Header value. |
| 239 | }, |
| 240 | ], |
| 241 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 242 | "violatingResource": { # Information regarding any resource causing the vulnerability such # Output only. An addon containing detailed information regarding any resource causing the |
| 243 | # vulnerability such as JavaScript sources, image, audio files, etc. |
| 244 | # as JavaScript sources, image, audio files, etc. |
| 245 | "resourceUrl": "A String", # URL of this violating resource. |
| 246 | "contentType": "A String", # The MIME type of this resource. |
| 247 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 248 | "severity": "A String", # Output only. The severity level of the reported vulnerability. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 249 | "fuzzedUrl": "A String", # Output only. The URL produced by the server-side fuzzer and used in the request that |
| 250 | # triggered the vulnerability. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 251 | "description": "A String", # Output only. The description of the vulnerability. |
| 252 | "xss": { # Information reported for an XSS. # Output only. An addon containing information reported for an XSS, if any. |
| 253 | "stackTraces": [ # Stack traces leading to the point where the XSS occurred. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 254 | "A String", |
| 255 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 256 | "attackVector": "A String", # The attack vector of the payload triggering this XSS. |
| 257 | "errorMessage": "A String", # An error message generated by a javascript breakage. |
| 258 | "storedXssSeedingUrl": "A String", # The reproduction url for the seeding POST request of a Stored XSS. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 259 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 260 | "form": { # ! Information about a vulnerability with an HTML. # Output only. An addon containing information reported for a vulnerability with an HTML |
| 261 | # form, if any. |
| 262 | "fields": [ # ! The names of form fields related to the vulnerability. |
| 263 | "A String", |
| 264 | ], |
| 265 | "actionUri": "A String", # ! The URI where to send the form when it's submitted. |
| 266 | }, |
| 267 | "httpMethod": "A String", # Output only. The http method of the request that triggered the vulnerability, in |
| 268 | # uppercase. |
| 269 | "finalUrl": "A String", # Output only. The URL where the browser lands when the vulnerability is detected. |
| 270 | "frameUrl": "A String", # Output only. If the vulnerability was originated from nested IFrame, the immediate |
| 271 | # parent IFrame is reported. |
| 272 | "reproductionUrl": "A String", # Output only. The URL containing human-readable payload that user can leverage to |
| 273 | # reproduce the vulnerability. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 274 | }, |
| 275 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 276 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| 277 | # more results in the list. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 278 | }</pre> |
| 279 | </div> |
| 280 | |
| 281 | <div class="method"> |
| 282 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 283 | <pre>Retrieves the next page of results. |
| 284 | |
| 285 | Args: |
| 286 | previous_request: The request for the previous page. (required) |
| 287 | previous_response: The response from the request for the previous page. (required) |
| 288 | |
| 289 | Returns: |
| 290 | A request object that you can call 'execute()' on to request the next |
| 291 | page. Returns None if there are no more items in the collection. |
| 292 | </pre> |
| 293 | </div> |
| 294 | |
| 295 | </body></html> |