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