chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
index c2f2343..1dd0f20 100644
--- a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
@@ -92,7 +92,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>
@@ -119,52 +119,21 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
- },
- "userAgent": "A String", # The user agent used during scanning.
- "riskLevel": "A String", # The risk level selected for the scan
- "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- "A String",
- ],
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
- "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",
- ],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
- "executionState": "A String", # The execution state of the ScanRun.
- "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 with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
- "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
- "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.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
- "fieldName": "A String", # 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", # Indicates the reason code for a configuration failure.
+ "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.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "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.
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
},
},
- "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.
- "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.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
"username": "A String", # Required. The user name of the custom account.
@@ -174,12 +143,43 @@
"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.
},
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
- },
- },
},
+ "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.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # 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", # 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.
+ },
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "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 with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ },
+ "userAgent": "A String", # The user agent used during scanning.
+ "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",
+ ],
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
+ "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
}
x__xgafv: string, V1 error format.
@@ -191,52 +191,21 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
- },
- "userAgent": "A String", # The user agent used during scanning.
- "riskLevel": "A String", # The risk level selected for the scan
- "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- "A String",
- ],
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
- "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",
- ],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
- "executionState": "A String", # The execution state of the ScanRun.
- "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 with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
- "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
- "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.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
- "fieldName": "A String", # 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", # Indicates the reason code for a configuration failure.
+ "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.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "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.
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
},
},
- "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.
- "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.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
"username": "A String", # Required. The user name of the custom account.
@@ -246,12 +215,43 @@
"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.
},
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
- },
- },
},
+ "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.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # 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", # 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.
+ },
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "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 with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ },
+ "userAgent": "A String", # The user agent used during scanning.
+ "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",
+ ],
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
+ "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
}</pre>
</div>
@@ -288,52 +288,21 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
- },
- "userAgent": "A String", # The user agent used during scanning.
- "riskLevel": "A String", # The risk level selected for the scan
- "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- "A String",
- ],
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
- "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",
- ],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
- "executionState": "A String", # The execution state of the ScanRun.
- "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 with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
- "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
- "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.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
- "fieldName": "A String", # 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", # Indicates the reason code for a configuration failure.
+ "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.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "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.
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
},
},
- "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.
- "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.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
"username": "A String", # Required. The user name of the custom account.
@@ -343,23 +312,54 @@
"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.
},
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
- },
- },
},
+ "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.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # 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", # 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.
+ },
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "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 with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ },
+ "userAgent": "A String", # The user agent used during scanning.
+ "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",
+ ],
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
+ "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "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
@@ -372,52 +372,21 @@
"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.
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
- },
- "userAgent": "A String", # The user agent used during scanning.
- "riskLevel": "A String", # The risk level selected for the scan
- "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- "A String",
- ],
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
- "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",
- ],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
- "executionState": "A String", # The execution state of the ScanRun.
- "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 with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
- "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
- "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.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
- "fieldName": "A String", # 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", # Indicates the reason code for a configuration failure.
+ "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.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "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.
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
},
},
- "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.
- "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.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
"username": "A String", # Required. The user name of the custom account.
@@ -427,12 +396,43 @@
"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.
},
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
- },
- },
},
+ "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.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # 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", # 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.
+ },
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "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 with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ },
+ "userAgent": "A String", # The user agent used during scanning.
+ "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",
+ ],
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
+ "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
},
],
}</pre>
@@ -462,52 +462,21 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
- },
- "userAgent": "A String", # The user agent used during scanning.
- "riskLevel": "A String", # The risk level selected for the scan
- "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- "A String",
- ],
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
- "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",
- ],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
- "executionState": "A String", # The execution state of the ScanRun.
- "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 with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
- "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
- "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.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
- "fieldName": "A String", # 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", # Indicates the reason code for a configuration failure.
+ "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.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "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.
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
},
},
- "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.
- "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.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
"username": "A String", # Required. The user name of the custom account.
@@ -517,12 +486,43 @@
"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.
},
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
- },
- },
},
+ "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.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # 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", # 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.
+ },
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "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 with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ },
+ "userAgent": "A String", # The user agent used during scanning.
+ "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",
+ ],
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
+ "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
}
updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
@@ -535,52 +535,21 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
- },
- "userAgent": "A String", # The user agent used during scanning.
- "riskLevel": "A String", # The risk level selected for the scan
- "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- "A String",
- ],
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
- "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",
- ],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
- "executionState": "A String", # The execution state of the ScanRun.
- "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 with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
- "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
- "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.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
- "fieldName": "A String", # 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", # Indicates the reason code for a configuration failure.
+ "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.
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "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.
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
},
},
- "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.
- "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.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
"username": "A String", # Required. The user name of the custom account.
@@ -590,12 +559,43 @@
"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.
},
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
- },
- },
},
+ "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.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # 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", # 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.
+ },
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "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 with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ },
+ "userAgent": "A String", # The user agent used during scanning.
+ "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",
+ ],
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
+ "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
}</pre>
</div>
@@ -621,26 +621,26 @@
{ # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
"executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # 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", # 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.
+ },
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
"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 with useful information that helps make the scanning process more effective.
"code": "A String", # Indicates the warning code.
},
],
"startTime": "A String", # The time at which the ScanRun started.
- "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.
- "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
- "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.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
- "fieldName": "A String", # 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", # Indicates the reason code for a configuration failure.
- },
- },
"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.
- "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.
+ "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.
"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.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
}</pre>
</div>