build: run docs regen in synth.py (#1059)
diff --git a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
index 8a8b0e9..203df67 100644
--- a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
@@ -119,67 +119,67 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "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.
- "userAgent": "A String", # The user agent used during scanning.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
- "A String",
- ],
- "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.
- },
- "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",
- ],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "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.
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- },
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
+ "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 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).
},
},
+ "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.
+ },
},
+ "userAgent": "A String", # The user agent used during scanning.
+ "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
+ "riskLevel": "A String", # The risk level selected for the scan
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "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".
+ "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.
"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.
},
],
- "executionState": "A String", # The execution state of the ScanRun.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "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.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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.
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
"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.
"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 reason code for a configuration failure.
},
+ "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.
},
+ "executionState": "A String", # The execution state of the ScanRun.
+ "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.
+ "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.
},
- "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
+ },
}
x__xgafv: string, V1 error format.
@@ -191,67 +191,67 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "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.
- "userAgent": "A String", # The user agent used during scanning.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
- "A String",
- ],
- "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.
- },
- "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",
- ],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "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.
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- },
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
+ "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 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).
},
},
+ "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.
+ },
},
+ "userAgent": "A String", # The user agent used during scanning.
+ "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
+ "riskLevel": "A String", # The risk level selected for the scan
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "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".
+ "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.
"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.
},
],
- "executionState": "A String", # The execution state of the ScanRun.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "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.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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.
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
"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.
"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 reason code for a configuration failure.
},
+ "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.
},
+ "executionState": "A String", # The execution state of the ScanRun.
+ "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.
+ "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.
},
- "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
+ },
}</pre>
</div>
@@ -288,67 +288,67 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "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.
- "userAgent": "A String", # The user agent used during scanning.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
- "A String",
- ],
- "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.
- },
- "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",
- ],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "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.
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- },
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
+ "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 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).
},
},
+ "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.
+ },
},
+ "userAgent": "A String", # The user agent used during scanning.
+ "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
+ "riskLevel": "A String", # The risk level selected for the scan
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "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".
+ "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.
"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.
},
],
- "executionState": "A String", # The execution state of the ScanRun.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "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.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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.
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
"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.
"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 reason code for a configuration failure.
},
+ "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.
},
+ "executionState": "A String", # The execution state of the ScanRun.
+ "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.
+ "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.
},
- "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
+ },
}</pre>
</div>
@@ -369,72 +369,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.
- "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.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
- "A String",
- ],
- "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.
- },
- "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",
- ],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "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.
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- },
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
+ "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 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).
},
},
+ "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.
+ },
},
+ "userAgent": "A String", # The user agent used during scanning.
+ "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
+ "riskLevel": "A String", # The risk level selected for the scan
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "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".
+ "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.
"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.
},
],
- "executionState": "A String", # The execution state of the ScanRun.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "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.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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.
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
"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.
"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 reason code for a configuration failure.
},
+ "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.
},
+ "executionState": "A String", # The execution state of the ScanRun.
+ "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.
+ "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.
},
- "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
+ },
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>
@@ -462,67 +462,67 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "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.
- "userAgent": "A String", # The user agent used during scanning.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
- "A String",
- ],
- "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.
- },
- "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",
- ],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "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.
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- },
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
+ "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 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).
},
},
+ "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.
+ },
},
+ "userAgent": "A String", # The user agent used during scanning.
+ "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
+ "riskLevel": "A String", # The risk level selected for the scan
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "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".
+ "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.
"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.
},
],
- "executionState": "A String", # The execution state of the ScanRun.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "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.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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.
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
"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.
"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 reason code for a configuration failure.
},
+ "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.
},
+ "executionState": "A String", # The execution state of the ScanRun.
+ "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.
+ "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.
},
- "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
+ },
}
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,67 +535,67 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
- "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.
- "userAgent": "A String", # The user agent used during scanning.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
- "A String",
- ],
- "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.
- },
- "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",
- ],
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "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.
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- },
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
+ "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 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).
},
},
+ "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.
+ },
},
+ "userAgent": "A String", # The user agent used during scanning.
+ "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
+ "riskLevel": "A String", # The risk level selected for the scan
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "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".
+ "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.
"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.
},
],
- "executionState": "A String", # The execution state of the ScanRun.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "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.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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.
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
"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.
"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 reason code for a configuration failure.
},
+ "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.
},
+ "executionState": "A String", # The execution state of the ScanRun.
+ "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.
+ "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.
},
- "riskLevel": "A String", # The risk level selected for the scan
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
+ "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
+ },
}</pre>
</div>
@@ -620,28 +620,28 @@
An object of the form:
{ # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "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".
+ "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.
"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.
},
],
- "executionState": "A String", # The execution state of the ScanRun.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "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.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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.
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
"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.
"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 reason code for a configuration failure.
},
+ "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.
},
+ "executionState": "A String", # The execution state of the ScanRun.
+ "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.
+ "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.
}</pre>
</div>