| 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></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.html">scanRuns()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the scanRuns Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 84 | <p class="firstline">Creates a new ScanConfig.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Deletes an existing ScanConfig and its child resources.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Gets a ScanConfig.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| 93 | <p class="firstline">Lists ScanConfigs under a given project.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 96 | <p class="firstline">Retrieves the next page of results.</p> |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 99 | <p class="firstline">Updates a ScanConfig. This method support partial update of a ScanConfig.</p> |
| 100 | <p class="toc_element"> |
| 101 | <code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p> |
| 102 | <p class="firstline">Start a ScanRun according to the given ScanConfig.</p> |
| 103 | <h3>Method Details</h3> |
| 104 | <div class="method"> |
| 105 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 106 | <pre>Creates a new ScanConfig. |
| 107 | |
| 108 | Args: |
| 109 | parent: string, Required. The parent resource name where the scan is created, which should be a |
| 110 | project resource name in the format 'projects/{projectId}'. (required) |
| 111 | body: object, The request body. |
| 112 | The object takes the form of: |
| 113 | |
| 114 | { # A ScanConfig resource contains the configurations to launch a scan. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 115 | "riskLevel": "A String", # The risk level selected for the scan |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig. |
| 117 | "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is |
| 118 | # refreshed by the server after each run. If unspecified, it will default |
| 119 | # to current server time, which means the scan will be scheduled to start |
| 120 | # immediately. |
| 121 | "intervalDurationDays": 42, # Required. The duration of time between executions in days. |
| 122 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 123 | "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the |
| 124 | # authentication configuration during scanning. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 125 | "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account. |
| 126 | "username": "A String", # Required. The user name of the custom account. |
| 127 | "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted |
| 128 | # and not returned in any response nor included in audit logs. |
| 129 | "loginUrl": "A String", # Required. The login form URL of the website. |
| 130 | }, |
| 131 | "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account. |
| 132 | "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted |
| 133 | # and not returned in any response nor included in audit logs. |
| 134 | "username": "A String", # Required. The user name of the Google account. |
| 135 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 136 | "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP). |
| 137 | "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service |
| 138 | # account is added in Identity-Aware-Proxy (IAP) access policies. |
| 139 | # service account is added in Identity-Aware-Proxy (IAP) access policies. |
| 140 | "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by |
| 141 | # Identity-Aware-Proxy (IAP). |
| 142 | }, |
| 143 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 144 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 145 | "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages. |
| 146 | "A String", |
| 147 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 148 | "displayName": "A String", # Required. The user provided display name of the ScanConfig. |
| 149 | "blacklistPatterns": [ # The excluded URL patterns as described in |
| 150 | # https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls |
| 151 | "A String", |
| 152 | ], |
| 153 | "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output |
| 154 | # only. |
| 155 | "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 |
| 156 | # inclusively. If the field is unspecified or its value is set 0, server will |
| 157 | # default to 15. Other values outside of [5, 20] range will be rejected with |
| 158 | # INVALID_ARGUMENT error. |
| 159 | "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security |
| 160 | # Command Center. |
| 161 | "userAgent": "A String", # The user agent used during scanning. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | "name": "A String", # The resource name of the ScanConfig. The name follows the format of |
| 163 | # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are |
| 164 | # generated by the system. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 165 | "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. |
| 166 | # If enabled, the scanner will access applications from static IP addresses. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 167 | } |
| 168 | |
| 169 | x__xgafv: string, V1 error format. |
| 170 | Allowed values |
| 171 | 1 - v1 error format |
| 172 | 2 - v2 error format |
| 173 | |
| 174 | Returns: |
| 175 | An object of the form: |
| 176 | |
| 177 | { # A ScanConfig resource contains the configurations to launch a scan. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 178 | "riskLevel": "A String", # The risk level selected for the scan |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 179 | "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig. |
| 180 | "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is |
| 181 | # refreshed by the server after each run. If unspecified, it will default |
| 182 | # to current server time, which means the scan will be scheduled to start |
| 183 | # immediately. |
| 184 | "intervalDurationDays": 42, # Required. The duration of time between executions in days. |
| 185 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 186 | "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the |
| 187 | # authentication configuration during scanning. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 188 | "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account. |
| 189 | "username": "A String", # Required. The user name of the custom account. |
| 190 | "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted |
| 191 | # and not returned in any response nor included in audit logs. |
| 192 | "loginUrl": "A String", # Required. The login form URL of the website. |
| 193 | }, |
| 194 | "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account. |
| 195 | "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted |
| 196 | # and not returned in any response nor included in audit logs. |
| 197 | "username": "A String", # Required. The user name of the Google account. |
| 198 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 199 | "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP). |
| 200 | "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service |
| 201 | # account is added in Identity-Aware-Proxy (IAP) access policies. |
| 202 | # service account is added in Identity-Aware-Proxy (IAP) access policies. |
| 203 | "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by |
| 204 | # Identity-Aware-Proxy (IAP). |
| 205 | }, |
| 206 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 207 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 208 | "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages. |
| 209 | "A String", |
| 210 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 211 | "displayName": "A String", # Required. The user provided display name of the ScanConfig. |
| 212 | "blacklistPatterns": [ # The excluded URL patterns as described in |
| 213 | # https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls |
| 214 | "A String", |
| 215 | ], |
| 216 | "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output |
| 217 | # only. |
| 218 | "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 |
| 219 | # inclusively. If the field is unspecified or its value is set 0, server will |
| 220 | # default to 15. Other values outside of [5, 20] range will be rejected with |
| 221 | # INVALID_ARGUMENT error. |
| 222 | "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security |
| 223 | # Command Center. |
| 224 | "userAgent": "A String", # The user agent used during scanning. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 225 | "name": "A String", # The resource name of the ScanConfig. The name follows the format of |
| 226 | # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are |
| 227 | # generated by the system. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 228 | "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. |
| 229 | # If enabled, the scanner will access applications from static IP addresses. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 230 | }</pre> |
| 231 | </div> |
| 232 | |
| 233 | <div class="method"> |
| 234 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 235 | <pre>Deletes an existing ScanConfig and its child resources. |
| 236 | |
| 237 | Args: |
| 238 | name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the |
| 239 | format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required) |
| 240 | x__xgafv: string, V1 error format. |
| 241 | Allowed values |
| 242 | 1 - v1 error format |
| 243 | 2 - v2 error format |
| 244 | |
| 245 | Returns: |
| 246 | An object of the form: |
| 247 | |
| 248 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 249 | # empty messages in your APIs. A typical example is to use it as the request |
| 250 | # or the response type of an API method. For instance: |
| 251 | # |
| 252 | # service Foo { |
| 253 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 254 | # } |
| 255 | # |
| 256 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 257 | }</pre> |
| 258 | </div> |
| 259 | |
| 260 | <div class="method"> |
| 261 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 262 | <pre>Gets a ScanConfig. |
| 263 | |
| 264 | Args: |
| 265 | name: string, Required. The resource name of the ScanConfig to be returned. The name follows the |
| 266 | format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required) |
| 267 | x__xgafv: string, V1 error format. |
| 268 | Allowed values |
| 269 | 1 - v1 error format |
| 270 | 2 - v2 error format |
| 271 | |
| 272 | Returns: |
| 273 | An object of the form: |
| 274 | |
| 275 | { # A ScanConfig resource contains the configurations to launch a scan. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 276 | "riskLevel": "A String", # The risk level selected for the scan |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 277 | "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig. |
| 278 | "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is |
| 279 | # refreshed by the server after each run. If unspecified, it will default |
| 280 | # to current server time, which means the scan will be scheduled to start |
| 281 | # immediately. |
| 282 | "intervalDurationDays": 42, # Required. The duration of time between executions in days. |
| 283 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 284 | "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the |
| 285 | # authentication configuration during scanning. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 286 | "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account. |
| 287 | "username": "A String", # Required. The user name of the custom account. |
| 288 | "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted |
| 289 | # and not returned in any response nor included in audit logs. |
| 290 | "loginUrl": "A String", # Required. The login form URL of the website. |
| 291 | }, |
| 292 | "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account. |
| 293 | "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted |
| 294 | # and not returned in any response nor included in audit logs. |
| 295 | "username": "A String", # Required. The user name of the Google account. |
| 296 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 297 | "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP). |
| 298 | "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service |
| 299 | # account is added in Identity-Aware-Proxy (IAP) access policies. |
| 300 | # service account is added in Identity-Aware-Proxy (IAP) access policies. |
| 301 | "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by |
| 302 | # Identity-Aware-Proxy (IAP). |
| 303 | }, |
| 304 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 305 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 306 | "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages. |
| 307 | "A String", |
| 308 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 309 | "displayName": "A String", # Required. The user provided display name of the ScanConfig. |
| 310 | "blacklistPatterns": [ # The excluded URL patterns as described in |
| 311 | # https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls |
| 312 | "A String", |
| 313 | ], |
| 314 | "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output |
| 315 | # only. |
| 316 | "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 |
| 317 | # inclusively. If the field is unspecified or its value is set 0, server will |
| 318 | # default to 15. Other values outside of [5, 20] range will be rejected with |
| 319 | # INVALID_ARGUMENT error. |
| 320 | "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security |
| 321 | # Command Center. |
| 322 | "userAgent": "A String", # The user agent used during scanning. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 323 | "name": "A String", # The resource name of the ScanConfig. The name follows the format of |
| 324 | # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are |
| 325 | # generated by the system. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 326 | "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. |
| 327 | # If enabled, the scanner will access applications from static IP addresses. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 328 | }</pre> |
| 329 | </div> |
| 330 | |
| 331 | <div class="method"> |
| 332 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| 333 | <pre>Lists ScanConfigs under a given project. |
| 334 | |
| 335 | Args: |
| 336 | parent: string, Required. The parent resource name, which should be a project resource name in the |
| 337 | format 'projects/{projectId}'. (required) |
| 338 | pageToken: string, A token identifying a page of results to be returned. This should be a |
| 339 | `next_page_token` value returned from a previous List request. |
| 340 | If unspecified, the first page of results is returned. |
| 341 | pageSize: integer, The maximum number of ScanConfigs to return, can be limited by server. |
| 342 | If not specified or not positive, the implementation will select a |
| 343 | reasonable value. |
| 344 | x__xgafv: string, V1 error format. |
| 345 | Allowed values |
| 346 | 1 - v1 error format |
| 347 | 2 - v2 error format |
| 348 | |
| 349 | Returns: |
| 350 | An object of the form: |
| 351 | |
| 352 | { # Response for the `ListScanConfigs` method. |
| 353 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| 354 | # more results in the list. |
| 355 | "scanConfigs": [ # The list of ScanConfigs returned. |
| 356 | { # A ScanConfig resource contains the configurations to launch a scan. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 357 | "riskLevel": "A String", # The risk level selected for the scan |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 358 | "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig. |
| 359 | "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is |
| 360 | # refreshed by the server after each run. If unspecified, it will default |
| 361 | # to current server time, which means the scan will be scheduled to start |
| 362 | # immediately. |
| 363 | "intervalDurationDays": 42, # Required. The duration of time between executions in days. |
| 364 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 365 | "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the |
| 366 | # authentication configuration during scanning. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 367 | "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account. |
| 368 | "username": "A String", # Required. The user name of the custom account. |
| 369 | "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted |
| 370 | # and not returned in any response nor included in audit logs. |
| 371 | "loginUrl": "A String", # Required. The login form URL of the website. |
| 372 | }, |
| 373 | "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account. |
| 374 | "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted |
| 375 | # and not returned in any response nor included in audit logs. |
| 376 | "username": "A String", # Required. The user name of the Google account. |
| 377 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 378 | "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP). |
| 379 | "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service |
| 380 | # account is added in Identity-Aware-Proxy (IAP) access policies. |
| 381 | # service account is added in Identity-Aware-Proxy (IAP) access policies. |
| 382 | "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by |
| 383 | # Identity-Aware-Proxy (IAP). |
| 384 | }, |
| 385 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 386 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 387 | "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages. |
| 388 | "A String", |
| 389 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 390 | "displayName": "A String", # Required. The user provided display name of the ScanConfig. |
| 391 | "blacklistPatterns": [ # The excluded URL patterns as described in |
| 392 | # https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls |
| 393 | "A String", |
| 394 | ], |
| 395 | "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output |
| 396 | # only. |
| 397 | "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 |
| 398 | # inclusively. If the field is unspecified or its value is set 0, server will |
| 399 | # default to 15. Other values outside of [5, 20] range will be rejected with |
| 400 | # INVALID_ARGUMENT error. |
| 401 | "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security |
| 402 | # Command Center. |
| 403 | "userAgent": "A String", # The user agent used during scanning. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 404 | "name": "A String", # The resource name of the ScanConfig. The name follows the format of |
| 405 | # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are |
| 406 | # generated by the system. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 407 | "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. |
| 408 | # If enabled, the scanner will access applications from static IP addresses. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 409 | }, |
| 410 | ], |
| 411 | }</pre> |
| 412 | </div> |
| 413 | |
| 414 | <div class="method"> |
| 415 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 416 | <pre>Retrieves the next page of results. |
| 417 | |
| 418 | Args: |
| 419 | previous_request: The request for the previous page. (required) |
| 420 | previous_response: The response from the request for the previous page. (required) |
| 421 | |
| 422 | Returns: |
| 423 | A request object that you can call 'execute()' on to request the next |
| 424 | page. Returns None if there are no more items in the collection. |
| 425 | </pre> |
| 426 | </div> |
| 427 | |
| 428 | <div class="method"> |
| 429 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 430 | <pre>Updates a ScanConfig. This method support partial update of a ScanConfig. |
| 431 | |
| 432 | Args: |
| 433 | name: string, The resource name of the ScanConfig. The name follows the format of |
| 434 | 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are |
| 435 | generated by the system. (required) |
| 436 | body: object, The request body. |
| 437 | The object takes the form of: |
| 438 | |
| 439 | { # A ScanConfig resource contains the configurations to launch a scan. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 440 | "riskLevel": "A String", # The risk level selected for the scan |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 441 | "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig. |
| 442 | "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is |
| 443 | # refreshed by the server after each run. If unspecified, it will default |
| 444 | # to current server time, which means the scan will be scheduled to start |
| 445 | # immediately. |
| 446 | "intervalDurationDays": 42, # Required. The duration of time between executions in days. |
| 447 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 448 | "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the |
| 449 | # authentication configuration during scanning. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 450 | "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account. |
| 451 | "username": "A String", # Required. The user name of the custom account. |
| 452 | "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted |
| 453 | # and not returned in any response nor included in audit logs. |
| 454 | "loginUrl": "A String", # Required. The login form URL of the website. |
| 455 | }, |
| 456 | "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account. |
| 457 | "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted |
| 458 | # and not returned in any response nor included in audit logs. |
| 459 | "username": "A String", # Required. The user name of the Google account. |
| 460 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 461 | "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP). |
| 462 | "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service |
| 463 | # account is added in Identity-Aware-Proxy (IAP) access policies. |
| 464 | # service account is added in Identity-Aware-Proxy (IAP) access policies. |
| 465 | "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by |
| 466 | # Identity-Aware-Proxy (IAP). |
| 467 | }, |
| 468 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 469 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 470 | "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages. |
| 471 | "A String", |
| 472 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 473 | "displayName": "A String", # Required. The user provided display name of the ScanConfig. |
| 474 | "blacklistPatterns": [ # The excluded URL patterns as described in |
| 475 | # https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls |
| 476 | "A String", |
| 477 | ], |
| 478 | "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output |
| 479 | # only. |
| 480 | "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 |
| 481 | # inclusively. If the field is unspecified or its value is set 0, server will |
| 482 | # default to 15. Other values outside of [5, 20] range will be rejected with |
| 483 | # INVALID_ARGUMENT error. |
| 484 | "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security |
| 485 | # Command Center. |
| 486 | "userAgent": "A String", # The user agent used during scanning. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 487 | "name": "A String", # The resource name of the ScanConfig. The name follows the format of |
| 488 | # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are |
| 489 | # generated by the system. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 490 | "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. |
| 491 | # If enabled, the scanner will access applications from static IP addresses. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 492 | } |
| 493 | |
| 494 | updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, |
| 495 | see |
| 496 | https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask |
| 497 | x__xgafv: string, V1 error format. |
| 498 | Allowed values |
| 499 | 1 - v1 error format |
| 500 | 2 - v2 error format |
| 501 | |
| 502 | Returns: |
| 503 | An object of the form: |
| 504 | |
| 505 | { # A ScanConfig resource contains the configurations to launch a scan. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 506 | "riskLevel": "A String", # The risk level selected for the scan |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 507 | "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig. |
| 508 | "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is |
| 509 | # refreshed by the server after each run. If unspecified, it will default |
| 510 | # to current server time, which means the scan will be scheduled to start |
| 511 | # immediately. |
| 512 | "intervalDurationDays": 42, # Required. The duration of time between executions in days. |
| 513 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 514 | "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the |
| 515 | # authentication configuration during scanning. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 516 | "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account. |
| 517 | "username": "A String", # Required. The user name of the custom account. |
| 518 | "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted |
| 519 | # and not returned in any response nor included in audit logs. |
| 520 | "loginUrl": "A String", # Required. The login form URL of the website. |
| 521 | }, |
| 522 | "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account. |
| 523 | "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted |
| 524 | # and not returned in any response nor included in audit logs. |
| 525 | "username": "A String", # Required. The user name of the Google account. |
| 526 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 527 | "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP). |
| 528 | "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service |
| 529 | # account is added in Identity-Aware-Proxy (IAP) access policies. |
| 530 | # service account is added in Identity-Aware-Proxy (IAP) access policies. |
| 531 | "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by |
| 532 | # Identity-Aware-Proxy (IAP). |
| 533 | }, |
| 534 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 535 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 536 | "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages. |
| 537 | "A String", |
| 538 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 539 | "displayName": "A String", # Required. The user provided display name of the ScanConfig. |
| 540 | "blacklistPatterns": [ # The excluded URL patterns as described in |
| 541 | # https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls |
| 542 | "A String", |
| 543 | ], |
| 544 | "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output |
| 545 | # only. |
| 546 | "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 |
| 547 | # inclusively. If the field is unspecified or its value is set 0, server will |
| 548 | # default to 15. Other values outside of [5, 20] range will be rejected with |
| 549 | # INVALID_ARGUMENT error. |
| 550 | "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security |
| 551 | # Command Center. |
| 552 | "userAgent": "A String", # The user agent used during scanning. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 553 | "name": "A String", # The resource name of the ScanConfig. The name follows the format of |
| 554 | # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are |
| 555 | # generated by the system. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 556 | "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. |
| 557 | # If enabled, the scanner will access applications from static IP addresses. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 558 | }</pre> |
| 559 | </div> |
| 560 | |
| 561 | <div class="method"> |
| 562 | <code class="details" id="start">start(name, body=None, x__xgafv=None)</code> |
| 563 | <pre>Start a ScanRun according to the given ScanConfig. |
| 564 | |
| 565 | Args: |
| 566 | name: string, Required. The resource name of the ScanConfig to be used. The name follows the |
| 567 | format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required) |
| 568 | body: object, The request body. |
| 569 | The object takes the form of: |
| 570 | |
| 571 | { # Request for the `StartScanRun` method. |
| 572 | } |
| 573 | |
| 574 | x__xgafv: string, V1 error format. |
| 575 | Allowed values |
| 576 | 1 - v1 error format |
| 577 | 2 - v2 error format |
| 578 | |
| 579 | Returns: |
| 580 | An object of the form: |
| 581 | |
| 582 | { # A ScanRun is a output-only resource representing an actual run of the scan. |
| 583 | # Next id: 12 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 584 | "errorTrace": { # Output only. # Output only. If result_state is an ERROR, this field provides the primary reason for |
| 585 | # scan's termination and more details, if such are available. |
| 586 | # Defines an error trace message for a ScanRun. |
| 587 | "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error |
| 588 | # message encountered during scan configuration validation that is performed |
| 589 | # before each scan run. |
| 590 | # APIs when scan configuration validation fails. It is also reported as part of |
| 591 | # a ScanRunErrorTrace message if scan validation fails due to a scan |
| 592 | # configuration error. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 593 | "code": "A String", # Output only. Indicates the reason code for a configuration failure. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 594 | "fieldName": "A String", # Output only. Indicates the full name of the ScanConfig field that triggers this error, |
| 595 | # for example "scan_config.max_qps". This field is provided for |
| 596 | # troubleshooting purposes only and its actual value can change in the |
| 597 | # future. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 598 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 599 | "code": "A String", # Output only. Indicates the error reason code. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 600 | "mostCommonHttpErrorCode": 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most |
| 601 | # common HTTP error code, if such is available. For example, if this code is |
| 602 | # 404, the scan has encountered too many NOT_FOUND responses. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 603 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 604 | "urlsTestedCount": "A String", # Output only. The number of URLs tested during this ScanRun. If the scan is in progress, |
| 605 | # the value represents the number of URLs tested up to now. The number of |
| 606 | # URLs tested is usually larger than the number URLS crawled because |
| 607 | # typically a crawled URL is tested with multiple test payloads. |
| 608 | "urlsCrawledCount": "A String", # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, |
| 609 | # the value represents the number of URLs crawled up to now. |
| 610 | "startTime": "A String", # Output only. The time at which the ScanRun started. |
| 611 | "progressPercent": 42, # Output only. The percentage of total completion ranging from 0 to 100. |
| 612 | # If the scan is in queue, the value is 0. |
| 613 | # If the scan is running, the value ranges from 0 to 100. |
| 614 | # If the scan is finished, the value is 100. |
| 615 | "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun |
| 616 | # is either finished or stopped by user. |
| 617 | "warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run. |
| 618 | { # Output only. |
| 619 | # Defines a warning trace message for ScanRun. Warning traces provide customers |
| 620 | # with useful information that helps make the scanning process more effective. |
| 621 | "code": "A String", # Output only. Indicates the warning code. |
| 622 | }, |
| 623 | ], |
| 624 | "executionState": "A String", # Output only. The execution state of the ScanRun. |
| 625 | "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the |
| 626 | # execution state reaches "FINISHED". |
| 627 | "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities. |
| 628 | "name": "A String", # Output only. The resource name of the ScanRun. The name follows the format of |
| 629 | # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. |
| 630 | # The ScanRun IDs are generated by the system. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 631 | }</pre> |
| 632 | </div> |
| 633 | |
| 634 | </body></html> |