docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html
index 9af3a0b..f48949d 100644
--- a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html
@@ -112,10 +112,7 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
- # Command Center.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
+ "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
@@ -123,15 +120,19 @@
# immediately.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "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.
- "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.
"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.
+ },
+ "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.
@@ -140,30 +141,29 @@
# 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.
- },
- "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.
- },
},
- "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
- # only.
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
"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.
@@ -175,10 +175,7 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
- # Command Center.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
+ "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
@@ -186,15 +183,19 @@
# immediately.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "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.
- "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.
"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.
+ },
+ "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.
@@ -203,30 +204,29 @@
# 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.
- },
- "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.
- },
},
- "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
- # only.
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
"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>
@@ -273,10 +273,7 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
- # Command Center.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
+ "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
@@ -284,15 +281,19 @@
# immediately.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "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.
- "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.
"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.
+ },
+ "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.
@@ -301,30 +302,29 @@
# 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.
- },
- "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.
- },
},
- "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
- # only.
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
"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>
@@ -354,10 +354,7 @@
# more results in the list.
"scanConfigs": [ # The list of ScanConfigs returned.
{ # A ScanConfig resource contains the configurations to launch a scan.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
- # Command Center.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
+ "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
@@ -365,15 +362,19 @@
# immediately.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "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.
- "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.
"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.
+ },
+ "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.
@@ -382,30 +383,29 @@
# 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.
- },
- "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.
- },
},
- "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
- # only.
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
"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>
@@ -437,10 +437,7 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
- # Command Center.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
+ "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
@@ -448,15 +445,19 @@
# immediately.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "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.
- "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.
"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.
+ },
+ "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.
@@ -465,30 +466,29 @@
# 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.
- },
- "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.
- },
},
- "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
- # only.
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
"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,
@@ -503,10 +503,7 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
- # Command Center.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
+ "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
@@ -514,15 +511,19 @@
# immediately.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "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.
- "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.
"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.
+ },
+ "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.
@@ -531,30 +532,29 @@
# 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.
- },
- "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.
- },
},
- "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
- # only.
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
"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>
@@ -581,33 +581,6 @@
{ # A ScanRun is a output-only resource representing an actual run of the scan.
# Next id: 12
- "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.
- "executionState": "A String", # Output only. The execution state of the ScanRun.
- "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # Output only. The time at which the ScanRun started.
- "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.
- "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
- "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.
- },
- ],
- "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.
"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.
@@ -617,17 +590,44 @@
# 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.
- "code": "A String", # Output only. Indicates the error reason code.
},
+ "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
+ # with useful information that helps make the scanning process more effective.
+ "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.
+ "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.
}</pre>
</div>