docs: update generated docs (#981)
diff --git a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html
index f48949d..054b343 100644
--- a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html
@@ -112,59 +112,59 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "riskLevel": "A String", # The risk level selected for the scan
- "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.
- },
- "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.
- "username": "A String", # Required. The user name of the 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.
- "loginUrl": "A String", # Required. The login form URL of the website.
+ "riskLevel": "A String", # The risk level selected for the 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.
+ "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",
+ ],
+ "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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
+ # only.
+ "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.
},
- "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.
- },
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # 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).
+ "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.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
+ # account is added in Identity-Aware-Proxy (IAP) access policies.
+ # 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.
+ "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.
},
},
- },
- "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.
- "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",
- ],
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
- # only.
- "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.
- "userAgent": "A String", # The user agent used during scanning.
- "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.
- "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.
-}
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -175,59 +175,59 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "riskLevel": "A String", # The risk level selected for the scan
- "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.
- },
- "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.
- "username": "A String", # Required. The user name of the 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.
- "loginUrl": "A String", # Required. The login form URL of the website.
+ "riskLevel": "A String", # The risk level selected for the 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.
+ "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",
+ ],
+ "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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
+ # only.
+ "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.
},
- "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.
- },
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # 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).
+ "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.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
+ # account is added in Identity-Aware-Proxy (IAP) access policies.
+ # 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.
+ "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.
},
},
- },
- "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.
- "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",
- ],
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
- # only.
- "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.
- "userAgent": "A String", # The user agent used during scanning.
- "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.
- "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.
- }</pre>
+ }</pre>
</div>
<div class="method">
@@ -273,59 +273,59 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "riskLevel": "A String", # The risk level selected for the scan
- "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.
- },
- "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.
- "username": "A String", # Required. The user name of the 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.
- "loginUrl": "A String", # Required. The login form URL of the website.
+ "riskLevel": "A String", # The risk level selected for the 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.
+ "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",
+ ],
+ "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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
+ # only.
+ "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.
},
- "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.
- },
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # 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).
+ "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.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
+ # account is added in Identity-Aware-Proxy (IAP) access policies.
+ # 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.
+ "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.
},
},
- },
- "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.
- "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",
- ],
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
- # only.
- "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.
- "userAgent": "A String", # The user agent used during scanning.
- "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.
- "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.
- }</pre>
+ }</pre>
</div>
<div class="method">
@@ -354,59 +354,59 @@
# more results in the list.
"scanConfigs": [ # The list of ScanConfigs returned.
{ # A ScanConfig resource contains the configurations to launch a scan.
- "riskLevel": "A String", # The risk level selected for the scan
- "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.
- },
- "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.
- "username": "A String", # Required. The user name of the 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.
- "loginUrl": "A String", # Required. The login form URL of the website.
+ "riskLevel": "A String", # The risk level selected for the 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.
+ "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",
+ ],
+ "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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
+ # only.
+ "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.
},
- "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.
- },
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # 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).
+ "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.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
+ # account is added in Identity-Aware-Proxy (IAP) access policies.
+ # 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.
+ "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.
},
},
},
- "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.
- "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",
- ],
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
- # only.
- "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.
- "userAgent": "A String", # The user agent used during scanning.
- "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.
- "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.
- },
],
}</pre>
</div>
@@ -437,59 +437,59 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "riskLevel": "A String", # The risk level selected for the scan
- "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.
- },
- "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.
- "username": "A String", # Required. The user name of the 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.
- "loginUrl": "A String", # Required. The login form URL of the website.
+ "riskLevel": "A String", # The risk level selected for the 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.
+ "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",
+ ],
+ "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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
+ # only.
+ "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.
},
- "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.
- },
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # 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).
+ "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.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
+ # account is added in Identity-Aware-Proxy (IAP) access policies.
+ # 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.
+ "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.
},
},
- },
- "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.
- "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",
- ],
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
- # only.
- "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.
- "userAgent": "A String", # The user agent used during scanning.
- "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.
- "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.
-}
+ }
updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition,
see
@@ -503,59 +503,59 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "riskLevel": "A String", # The risk level selected for the scan
- "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.
- },
- "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.
- "username": "A String", # Required. The user name of the 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.
- "loginUrl": "A String", # Required. The login form URL of the website.
+ "riskLevel": "A String", # The risk level selected for the 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.
+ "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",
+ ],
+ "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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
+ # only.
+ "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.
},
- "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.
- },
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # 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).
+ "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.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
+ # account is added in Identity-Aware-Proxy (IAP) access policies.
+ # 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.
+ "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.
},
},
- },
- "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.
- "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",
- ],
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
- # only.
- "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.
- "userAgent": "A String", # The user agent used during scanning.
- "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.
- "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.
- }</pre>
+ }</pre>
</div>
<div class="method">
@@ -584,36 +584,25 @@
"errorTrace": { # Output only. # 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.
# Defines an error trace message for a ScanRun.
+ "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 # 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.
# 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.
- "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.
},
"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.
},
- "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.
- "startTime": "A String", # Output only. The time at which the ScanRun started.
- "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.
"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
@@ -621,13 +610,24 @@
"code": "A String", # Output only. Indicates the warning code.
},
],
- "executionState": "A String", # Output only. The execution state of the ScanRun.
"resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the
# execution state reaches "FINISHED".
- "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
+ "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.
"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.
+ "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "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.
+ "startTime": "A String", # Output only. The time at which the ScanRun started.
}</pre>
</div>