docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
index eaa21dd..a985b0a 100644
--- a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
@@ -89,7 +89,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a ScanConfig.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists ScanConfigs under a given project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -112,28 +112,68 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security
+ # Command Center.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
+ # only.
+ "userAgent": "A String", # The user agent used during scanning.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ },
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
+ # authentication configuration during scanning.
+ "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).
+ },
+ },
+ "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.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ },
+ "riskLevel": "A String", # The risk level selected for the scan
+ "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",
],
- "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 Cloud Security
- # Command Center.
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
+ "progressPercent": 42, # 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.
+ "name": "A String", # 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.
"executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # 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, # Whether the scan run has found any vulnerabilities.
+ "startTime": "A String", # The time at which the ScanRun started.
"urlsTestedCount": "A String", # 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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "urlsCrawledCount": "A String", # 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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
"warningTraces": [ # 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
@@ -141,11 +181,6 @@
"code": "A String", # Indicates the warning code.
},
],
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "name": "A String", # 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. # 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.
@@ -161,61 +196,26 @@
# future.
"code": "A String", # Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # 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", # Indicates the error reason code.
},
- "progressPercent": 42, # 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.
},
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "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.
- },
- "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.
"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.
- "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.
- },
- "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).
- },
- },
- },
- "riskLevel": "A String", # The risk level selected for the scan
- "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
+ "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.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "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.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
+ # will be used as a default.
"A String",
],
}
@@ -229,28 +229,68 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security
+ # Command Center.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
+ # only.
+ "userAgent": "A String", # The user agent used during scanning.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ },
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
+ # authentication configuration during scanning.
+ "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).
+ },
+ },
+ "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.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ },
+ "riskLevel": "A String", # The risk level selected for the scan
+ "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",
],
- "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 Cloud Security
- # Command Center.
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
+ "progressPercent": 42, # 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.
+ "name": "A String", # 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.
"executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # 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, # Whether the scan run has found any vulnerabilities.
+ "startTime": "A String", # The time at which the ScanRun started.
"urlsTestedCount": "A String", # 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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "urlsCrawledCount": "A String", # 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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
"warningTraces": [ # 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
@@ -258,11 +298,6 @@
"code": "A String", # Indicates the warning code.
},
],
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "name": "A String", # 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. # 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.
@@ -278,61 +313,26 @@
# future.
"code": "A String", # Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # 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", # Indicates the error reason code.
},
- "progressPercent": 42, # 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.
},
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "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.
- },
- "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.
"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.
- "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.
- },
- "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).
- },
- },
- },
- "riskLevel": "A String", # The risk level selected for the scan
- "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
+ "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.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "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.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
+ # will be used as a default.
"A String",
],
}</pre>
@@ -381,28 +381,68 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security
+ # Command Center.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
+ # only.
+ "userAgent": "A String", # The user agent used during scanning.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ },
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
+ # authentication configuration during scanning.
+ "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).
+ },
+ },
+ "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.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ },
+ "riskLevel": "A String", # The risk level selected for the scan
+ "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",
],
- "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 Cloud Security
- # Command Center.
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
+ "progressPercent": 42, # 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.
+ "name": "A String", # 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.
"executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # 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, # Whether the scan run has found any vulnerabilities.
+ "startTime": "A String", # The time at which the ScanRun started.
"urlsTestedCount": "A String", # 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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "urlsCrawledCount": "A String", # 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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
"warningTraces": [ # 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
@@ -410,11 +450,6 @@
"code": "A String", # Indicates the warning code.
},
],
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "name": "A String", # 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. # 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.
@@ -430,79 +465,44 @@
# future.
"code": "A String", # Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # 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", # Indicates the error reason code.
},
- "progressPercent": 42, # 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.
},
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "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.
- },
- "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.
"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.
- "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.
- },
- "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).
- },
- },
- },
- "riskLevel": "A String", # The risk level selected for the scan
- "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
+ "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.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "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.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
+ # will be used as a default.
"A String",
],
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists ScanConfigs under a given project.
Args:
parent: string, Required. The parent resource name, which should be a project resource name in the
format 'projects/{projectId}'. (required)
- pageSize: integer, The maximum number of ScanConfigs to return, can be limited by server.
-If not specified or not positive, the implementation will select a
-reasonable value.
pageToken: string, A token identifying a page of results to be returned. This should be a
`next_page_token` value returned from a previous List request.
If unspecified, the first page of results is returned.
+ pageSize: integer, The maximum number of ScanConfigs to return, can be limited by server.
+If not specified or not positive, the implementation will select a
+reasonable value.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -512,30 +512,72 @@
An object of the form:
{ # Response for the `ListScanConfigs` method.
+ "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.
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security
+ # Command Center.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
+ # only.
+ "userAgent": "A String", # The user agent used during scanning.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ },
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
+ # authentication configuration during scanning.
+ "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).
+ },
+ },
+ "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.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ },
+ "riskLevel": "A String", # The risk level selected for the scan
+ "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",
],
- "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 Cloud Security
- # Command Center.
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
+ "progressPercent": 42, # 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.
+ "name": "A String", # 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.
"executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # 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, # Whether the scan run has found any vulnerabilities.
+ "startTime": "A String", # The time at which the ScanRun started.
"urlsTestedCount": "A String", # 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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "urlsCrawledCount": "A String", # 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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
"warningTraces": [ # 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
@@ -543,11 +585,6 @@
"code": "A String", # Indicates the warning code.
},
],
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "name": "A String", # 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. # 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.
@@ -563,67 +600,30 @@
# future.
"code": "A String", # Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # 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", # Indicates the error reason code.
},
- "progressPercent": 42, # 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.
},
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "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.
- },
- "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.
"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.
- "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.
- },
- "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).
- },
- },
- },
- "riskLevel": "A String", # The risk level selected for the scan
- "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
+ "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.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "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.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
+ # will be used as a default.
"A String",
],
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
}</pre>
</div>
@@ -653,28 +653,68 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security
+ # Command Center.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
+ # only.
+ "userAgent": "A String", # The user agent used during scanning.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ },
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
+ # authentication configuration during scanning.
+ "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).
+ },
+ },
+ "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.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ },
+ "riskLevel": "A String", # The risk level selected for the scan
+ "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",
],
- "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 Cloud Security
- # Command Center.
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
+ "progressPercent": 42, # 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.
+ "name": "A String", # 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.
"executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # 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, # Whether the scan run has found any vulnerabilities.
+ "startTime": "A String", # The time at which the ScanRun started.
"urlsTestedCount": "A String", # 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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "urlsCrawledCount": "A String", # 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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
"warningTraces": [ # 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
@@ -682,11 +722,6 @@
"code": "A String", # Indicates the warning code.
},
],
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "name": "A String", # 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. # 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.
@@ -702,61 +737,26 @@
# future.
"code": "A String", # Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # 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", # Indicates the error reason code.
},
- "progressPercent": 42, # 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.
},
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "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.
- },
- "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.
"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.
- "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.
- },
- "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).
- },
- },
- },
- "riskLevel": "A String", # The risk level selected for the scan
- "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
+ "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.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "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.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
+ # will be used as a default.
"A String",
],
}
@@ -773,28 +773,68 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security
+ # Command Center.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
+ # only.
+ "userAgent": "A String", # The user agent used during scanning.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ },
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
+ # authentication configuration during scanning.
+ "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).
+ },
+ },
+ "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.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ },
+ "riskLevel": "A String", # The risk level selected for the scan
+ "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",
],
- "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 Cloud Security
- # Command Center.
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
+ "progressPercent": 42, # 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.
+ "name": "A String", # 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.
"executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # 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, # Whether the scan run has found any vulnerabilities.
+ "startTime": "A String", # The time at which the ScanRun started.
"urlsTestedCount": "A String", # 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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "urlsCrawledCount": "A String", # 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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
"warningTraces": [ # 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
@@ -802,11 +842,6 @@
"code": "A String", # Indicates the warning code.
},
],
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "name": "A String", # 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. # 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.
@@ -822,61 +857,26 @@
# future.
"code": "A String", # Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # 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", # Indicates the error reason code.
},
- "progressPercent": 42, # 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.
},
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "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.
- },
- "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.
"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.
- "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.
- },
- "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).
- },
- },
- },
- "riskLevel": "A String", # The risk level selected for the scan
- "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
+ "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.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "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.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
+ # will be used as a default.
"A String",
],
}</pre>
@@ -905,17 +905,26 @@
{ # A ScanRun is a output-only resource representing an actual run of the scan.
# Next id: 12
+ "progressPercent": 42, # 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.
+ "name": "A String", # 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.
"executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # 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, # Whether the scan run has found any vulnerabilities.
+ "startTime": "A String", # The time at which the ScanRun started.
"urlsTestedCount": "A String", # 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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "urlsCrawledCount": "A String", # 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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
"warningTraces": [ # 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
@@ -923,11 +932,6 @@
"code": "A String", # Indicates the warning code.
},
],
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "name": "A String", # 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. # 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.
@@ -943,15 +947,11 @@
# future.
"code": "A String", # Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # 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", # Indicates the error reason code.
},
- "progressPercent": 42, # 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.
}</pre>
</div>