docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
index 7485c7b..8a8b0e9 100644
--- a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
@@ -80,6 +80,9 @@
<p class="firstline">Returns the scanRuns Resource.</p>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new ScanConfig.</p>
<p class="toc_element">
@@ -89,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, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=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>
@@ -102,123 +105,82 @@
<p class="firstline">Start a ScanRun according to the given ScanConfig.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new ScanConfig.
Args:
- parent: string, Required. The parent resource name where the scan is created, which should be a
-project resource name in the format 'projects/{projectId}'. (required)
+ parent: string, Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. (required)
body: object, The request body.
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
- # inclusively. If the field is unspecified or its value is set 0, server will
- # default to 15. Other values outside of [5, 20] range will be rejected with
- # INVALID_ARGUMENT error.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- # Next id: 12
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
- # Defines an error trace message for a ScanRun.
- "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 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
- # message encountered during scan configuration validation that is performed
- # before each scan run.
- # APIs when scan configuration validation fails. It is also reported as part of
- # a ScanRunErrorTrace message if scan validation fails due to a scan
- # configuration error.
- "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.
- },
- },
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
- "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.
- },
- ],
- "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.
- "executionState": "A String", # The execution state of the ScanRun.
- "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.
- "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.
+ "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.
},
- "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.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
- # only.
- "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",
- ],
- "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.
+ "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.
},
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
- # generated by the system.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security
- # Command Center.
- "userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "riskLevel": "A String", # The risk level selected for the scan
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
- "username": "A String", # Required. The user name of the Google account.
- },
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
- # Identity-Aware-Proxy(IAP).
- },
- },
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "username": "A String", # Required. The user name of the custom account.
+ "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).
},
},
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- }
+ },
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "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.
+ },
+ },
+ },
+ "riskLevel": "A String", # The risk level selected for the scan
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -229,113 +191,68 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
- # inclusively. If the field is unspecified or its value is set 0, server will
- # default to 15. Other values outside of [5, 20] range will be rejected with
- # INVALID_ARGUMENT error.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- # Next id: 12
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
- # Defines an error trace message for a ScanRun.
- "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 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
- # message encountered during scan configuration validation that is performed
- # before each scan run.
- # APIs when scan configuration validation fails. It is also reported as part of
- # a ScanRunErrorTrace message if scan validation fails due to a scan
- # configuration error.
- "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.
- },
- },
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
- "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.
- },
- ],
- "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.
- "executionState": "A String", # The execution state of the ScanRun.
- "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.
- "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.
+ "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.
},
- "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.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
- # only.
- "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",
- ],
- "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.
+ "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.
},
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
- # generated by the system.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security
- # Command Center.
- "userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "riskLevel": "A String", # The risk level selected for the scan
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
- "username": "A String", # Required. The user name of the Google account.
- },
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
- # Identity-Aware-Proxy(IAP).
- },
- },
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "username": "A String", # Required. The user name of the custom account.
+ "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).
},
},
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- }</pre>
+ },
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "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.
+ },
+ },
+ },
+ "riskLevel": "A String", # The risk level selected for the scan
+ }</pre>
</div>
<div class="method">
@@ -343,8 +260,7 @@
<pre>Deletes an existing ScanConfig and its child resources.
Args:
- name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the
-format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
+ name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -353,15 +269,7 @@
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated
- # empty messages in your APIs. A typical example is to use it as the request
- # or the response type of an API method. For instance:
- #
- # service Foo {
- # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
- # }
- #
- # The JSON representation for `Empty` is empty JSON object `{}`.
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
@@ -370,8 +278,7 @@
<pre>Gets a ScanConfig.
Args:
- name: string, Required. The resource name of the ScanConfig to be returned. The name follows the
-format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
+ name: string, Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -381,128 +288,78 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
- # inclusively. If the field is unspecified or its value is set 0, server will
- # default to 15. Other values outside of [5, 20] range will be rejected with
- # INVALID_ARGUMENT error.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- # Next id: 12
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
- # Defines an error trace message for a ScanRun.
- "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 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
- # message encountered during scan configuration validation that is performed
- # before each scan run.
- # APIs when scan configuration validation fails. It is also reported as part of
- # a ScanRunErrorTrace message if scan validation fails due to a scan
- # configuration error.
- "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.
- },
- },
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
- "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.
- },
- ],
- "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.
- "executionState": "A String", # The execution state of the ScanRun.
- "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.
- "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.
+ "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.
},
- "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.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
- # only.
- "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",
- ],
- "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.
+ "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.
},
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
- # generated by the system.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security
- # Command Center.
- "userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "riskLevel": "A String", # The risk level selected for the scan
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
- "username": "A String", # Required. The user name of the Google account.
- },
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
- # Identity-Aware-Proxy(IAP).
- },
- },
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "username": "A String", # Required. The user name of the custom account.
+ "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).
},
},
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- }</pre>
+ },
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "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.
+ },
+ },
+ },
+ "riskLevel": "A String", # The risk level selected for the scan
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=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)
- 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.
+ 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -514,116 +371,70 @@
{ # Response for the `ListScanConfigs` method.
"scanConfigs": [ # The list of ScanConfigs returned.
{ # A ScanConfig resource contains the configurations to launch a scan.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
- # inclusively. If the field is unspecified or its value is set 0, server will
- # default to 15. Other values outside of [5, 20] range will be rejected with
- # INVALID_ARGUMENT error.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- # Next id: 12
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
- # Defines an error trace message for a ScanRun.
- "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 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
- # message encountered during scan configuration validation that is performed
- # before each scan run.
- # APIs when scan configuration validation fails. It is also reported as part of
- # a ScanRunErrorTrace message if scan validation fails due to a scan
- # configuration error.
- "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.
- },
- },
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
- "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.
- },
- ],
- "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.
- "executionState": "A String", # The execution state of the ScanRun.
- "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.
- "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.
- },
- "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.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
- # only.
- "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",
- ],
- "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.
- },
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
- # generated by the system.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security
- # Command Center.
- "userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "riskLevel": "A String", # The risk level selected for the scan
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
- "username": "A String", # Required. The user name of the Google account.
- },
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
- # Identity-Aware-Proxy(IAP).
- },
- },
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "username": "A String", # Required. The user name of the custom account.
- },
- },
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "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.
+ },
+ "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).
+ },
+ },
+ },
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "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.
+ },
+ },
+ },
+ "riskLevel": "A String", # The risk level selected for the scan
+ },
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>
@@ -646,124 +457,75 @@
<pre>Updates a ScanConfig. This method support partial update of a ScanConfig.
Args:
- name: 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. (required)
+ name: 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. (required)
body: object, The request body.
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
- # inclusively. If the field is unspecified or its value is set 0, server will
- # default to 15. Other values outside of [5, 20] range will be rejected with
- # INVALID_ARGUMENT error.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- # Next id: 12
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
- # Defines an error trace message for a ScanRun.
- "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 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
- # message encountered during scan configuration validation that is performed
- # before each scan run.
- # APIs when scan configuration validation fails. It is also reported as part of
- # a ScanRunErrorTrace message if scan validation fails due to a scan
- # configuration error.
- "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.
- },
- },
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
- "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.
- },
- ],
- "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.
- "executionState": "A String", # The execution state of the ScanRun.
- "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.
- "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.
+ "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.
},
- "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.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
- # only.
- "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",
- ],
- "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.
+ "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.
},
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
- # generated by the system.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security
- # Command Center.
- "userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "riskLevel": "A String", # The risk level selected for the scan
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
- "username": "A String", # Required. The user name of the Google account.
- },
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
- # Identity-Aware-Proxy(IAP).
- },
- },
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "username": "A String", # Required. The user name of the custom account.
+ "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).
},
},
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- }
+ },
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "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.
+ },
+ },
+ },
+ "riskLevel": "A String", # The risk level selected for the scan
+}
- 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
+ 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
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -773,113 +535,68 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
- # inclusively. If the field is unspecified or its value is set 0, server will
- # default to 15. Other values outside of [5, 20] range will be rejected with
- # INVALID_ARGUMENT error.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- # Next id: 12
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
- # Defines an error trace message for a ScanRun.
- "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 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
- # message encountered during scan configuration validation that is performed
- # before each scan run.
- # APIs when scan configuration validation fails. It is also reported as part of
- # a ScanRunErrorTrace message if scan validation fails due to a scan
- # configuration error.
- "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.
- },
- },
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
- "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.
- },
- ],
- "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.
- "executionState": "A String", # The execution state of the ScanRun.
- "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.
- "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.
+ "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.
},
- "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.
- "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output
- # only.
- "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",
- ],
- "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.
+ "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.
},
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
- # generated by the system.
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security
- # Command Center.
- "userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "riskLevel": "A String", # The risk level selected for the scan
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
- "username": "A String", # Required. The user name of the Google account.
- },
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
- # Identity-Aware-Proxy(IAP).
- },
- },
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "username": "A String", # Required. The user name of the custom account.
+ "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).
},
},
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- }</pre>
+ },
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.
+ "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.
+ },
+ },
+ },
+ "riskLevel": "A String", # The risk level selected for the scan
+ }</pre>
</div>
<div class="method">
@@ -887,8 +604,7 @@
<pre>Start a ScanRun according to the given ScanConfig.
Args:
- name: string, Required. The resource name of the ScanConfig to be used. The name follows the
-format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
+ name: string, Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
body: object, The request body.
The object takes the form of:
@@ -903,55 +619,29 @@
Returns:
An object of the form:
- { # A ScanRun is a output-only resource representing an actual run of the scan.
- # Next id: 12
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
- # Defines an error trace message for a ScanRun.
- "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 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
- # message encountered during scan configuration validation that is performed
- # before each scan run.
- # APIs when scan configuration validation fails. It is also reported as part of
- # a ScanRunErrorTrace message if scan validation fails due to a scan
- # configuration error.
- "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.
- },
- },
- "startTime": "A String", # The time at which the ScanRun started.
- "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.
+ { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
"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.
+ { # 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.
},
],
- "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.
"executionState": "A String", # The execution state of the ScanRun.
- "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.
"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.
+ "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.
+ },
+ },
}</pre>
</div>