chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html
index 4fc5bad..083b1a7 100644
--- a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html
@@ -119,41 +119,41 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "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.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
- "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.
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
- "A String",
- ],
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "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.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
- },
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "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.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "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.
+ },
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "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.
+ "userAgent": "A String", # The user agent used during scanning.
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
+ "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "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.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
+ },
+ },
+ "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
+ "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.
+ "username": "A String", # Required. The user name of the Google account.
},
},
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
- "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.
- },
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "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.
- },
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "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.
- "riskLevel": "A String", # The risk level selected for the scan
-}
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
+ "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.
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -164,41 +164,41 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "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.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
- "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.
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
- "A String",
- ],
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "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.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
- },
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "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.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "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.
+ },
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "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.
+ "userAgent": "A String", # The user agent used during scanning.
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
+ "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "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.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
+ },
+ },
+ "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
+ "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.
+ "username": "A String", # Required. The user name of the Google account.
},
},
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
- "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.
- },
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "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.
- },
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "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.
- "riskLevel": "A String", # The risk level selected for the scan
- }</pre>
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
+ "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.
+ }</pre>
</div>
<div class="method">
@@ -234,41 +234,41 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "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.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
- "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.
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
- "A String",
- ],
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "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.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
- },
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "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.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "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.
+ },
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "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.
+ "userAgent": "A String", # The user agent used during scanning.
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
+ "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "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.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
+ },
+ },
+ "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
+ "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.
+ "username": "A String", # Required. The user name of the Google account.
},
},
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
- "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.
- },
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "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.
- },
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "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.
- "riskLevel": "A String", # The risk level selected for the scan
- }</pre>
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
+ "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.
+ }</pre>
</div>
<div class="method">
@@ -291,41 +291,41 @@
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"scanConfigs": [ # The list of ScanConfigs returned.
{ # A ScanConfig resource contains the configurations to launch a scan.
- "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.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
- "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.
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
- "A String",
- ],
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "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.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
- },
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "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.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "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.
+ },
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "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.
+ "userAgent": "A String", # The user agent used during scanning.
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
+ "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "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.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
+ },
+ },
+ "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
+ "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.
+ "username": "A String", # Required. The user name of the Google account.
},
},
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
- "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.
- },
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "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.
- },
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
+ "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.
},
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "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.
- "riskLevel": "A String", # The risk level selected for the scan
- },
],
}</pre>
</div>
@@ -354,41 +354,41 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "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.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
- "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.
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
- "A String",
- ],
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "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.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
- },
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "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.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "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.
+ },
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "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.
+ "userAgent": "A String", # The user agent used during scanning.
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
+ "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "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.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
+ },
+ },
+ "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
+ "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.
+ "username": "A String", # Required. The user name of the Google account.
},
},
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
- "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.
- },
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "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.
- },
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "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.
- "riskLevel": "A String", # The risk level selected for the scan
-}
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
+ "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.
+ }
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
x__xgafv: string, V1 error format.
@@ -400,41 +400,41 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "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.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
- "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.
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
- "A String",
- ],
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "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.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
- },
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "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.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "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.
+ },
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "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.
+ "userAgent": "A String", # The user agent used during scanning.
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
+ "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "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.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).
+ },
+ },
+ "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
+ "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.
+ "username": "A String", # Required. The user name of the Google account.
},
},
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
- "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.
- },
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "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.
- },
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "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.
- "riskLevel": "A String", # The risk level selected for the scan
- }</pre>
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
+ "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.
+ }</pre>
</div>
<div class="method">
@@ -458,28 +458,28 @@
An object of the form:
{ # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
+ "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.
+ "startTime": "A String", # Output only. The time at which the ScanRun started.
+ "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.
"warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
"code": "A String", # Output only. Indicates the warning code.
},
],
- "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.
+ "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
"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.
"code": "A String", # Output only. Indicates the error reason code.
- "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.
"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.
- "code": "A String", # Output only. Indicates the reason code for a configuration failure.
"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.
+ "code": "A String", # Output only. Indicates the reason code for a configuration failure.
},
+ "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.
},
- "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.
- "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.
- "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- "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.
"hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
- "startTime": "A String", # Output only. The time at which the ScanRun started.
- "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
"executionState": "A String", # Output only. The execution state of the ScanRun.
+ "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.
+ "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.
+ "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
}</pre>
</div>