chore: regens API reference docs (#889)
diff --git a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
index 65e1692..e98bb9c 100644
--- a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
@@ -80,7 +80,7 @@
<p class="firstline">Returns the scanRuns Resource.</p>
<p class="toc_element">
- <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
+ <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">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -89,36 +89,38 @@
<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, x__xgafv=None, pageSize=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>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a ScanConfig. This method support partial update of a ScanConfig.</p>
<p class="toc_element">
<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Start a ScanRun according to the given ScanConfig.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
+ <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
+ 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. (required)
+ body: object, The request body.
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
# inclusively. If the field is unspecified or its value is set 0, server will
# default to 15. Other values outside of [5, 20] range will be rejected with
# INVALID_ARGUMENT error.
- "displayName": "A String", # Required.
- # The user provided display name of the ScanConfig.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"name": "A String", # The resource name of the ScanConfig. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
# generated by the system.
@@ -127,112 +129,94 @@
# 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.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "riskLevel": "A String", # The risk level selected for the scan
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
# Command Center.
"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
# used as a default.
"A String",
],
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "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.
+ "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).
+ },
+ },
"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", # Input only.
- # Required.
- # The password of the Google account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required.
- # The user name of the custom account.
- "loginUrl": "A String", # Required.
- # The login form URL of the website.
- "password": "A String", # Input only.
- # Required.
- # The password of the custom account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
},
+ "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 Cloud Web Security Scanner, output
+ # only.
"userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required.
- # The starting URLs from which the scanner finds site pages.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
- "warningTraces": [ # Output only.
- # A list of warnings, if such are encountered during this scan run.
+ "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", # Output only.
- # Indicates the warning code.
+ "code": "A String", # Indicates the warning code.
},
],
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "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.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "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. # Output only.
- # If result_state is an ERROR, this field provides the primary reason for
+ "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.
- "mostCommonHttpErrorCode": 42, # Output only.
- # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Output only.
- # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
- # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "code": "A String", # Indicates the error reason code.
+ "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.
- "code": "A String", # Output only.
- # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Output only.
- # Indicates the full name of the ScanConfig field that triggers this error,
+ "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.
},
},
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
}
@@ -245,12 +229,15 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
# inclusively. If the field is unspecified or its value is set 0, server will
# default to 15. Other values outside of [5, 20] range will be rejected with
# INVALID_ARGUMENT error.
- "displayName": "A String", # Required.
- # The user provided display name of the ScanConfig.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"name": "A String", # The resource name of the ScanConfig. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
# generated by the system.
@@ -259,112 +246,94 @@
# 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.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "riskLevel": "A String", # The risk level selected for the scan
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
# Command Center.
"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
# used as a default.
"A String",
],
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "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.
+ "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).
+ },
+ },
"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", # Input only.
- # Required.
- # The password of the Google account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required.
- # The user name of the custom account.
- "loginUrl": "A String", # Required.
- # The login form URL of the website.
- "password": "A String", # Input only.
- # Required.
- # The password of the custom account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
},
+ "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 Cloud Web Security Scanner, output
+ # only.
"userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required.
- # The starting URLs from which the scanner finds site pages.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
- "warningTraces": [ # Output only.
- # A list of warnings, if such are encountered during this scan run.
+ "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", # Output only.
- # Indicates the warning code.
+ "code": "A String", # Indicates the warning code.
},
],
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "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.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "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. # Output only.
- # If result_state is an ERROR, this field provides the primary reason for
+ "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.
- "mostCommonHttpErrorCode": 42, # Output only.
- # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Output only.
- # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
- # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "code": "A String", # Indicates the error reason code.
+ "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.
- "code": "A String", # Output only.
- # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Output only.
- # Indicates the full name of the ScanConfig field that triggers this error,
+ "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.
},
},
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
}</pre>
</div>
@@ -374,8 +343,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
+ 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
@@ -402,8 +370,7 @@
<pre>Gets a ScanConfig.
Args:
- name: string, Required.
-The resource name of the ScanConfig to be returned. The name follows the
+ 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
@@ -414,12 +381,15 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
# inclusively. If the field is unspecified or its value is set 0, server will
# default to 15. Other values outside of [5, 20] range will be rejected with
# INVALID_ARGUMENT error.
- "displayName": "A String", # Required.
- # The user provided display name of the ScanConfig.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"name": "A String", # The resource name of the ScanConfig. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
# generated by the system.
@@ -428,124 +398,108 @@
# 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.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "riskLevel": "A String", # The risk level selected for the scan
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
# Command Center.
"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
# used as a default.
"A String",
],
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "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.
+ "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).
+ },
+ },
"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", # Input only.
- # Required.
- # The password of the Google account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required.
- # The user name of the custom account.
- "loginUrl": "A String", # Required.
- # The login form URL of the website.
- "password": "A String", # Input only.
- # Required.
- # The password of the custom account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
},
+ "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 Cloud Web Security Scanner, output
+ # only.
"userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required.
- # The starting URLs from which the scanner finds site pages.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
- "warningTraces": [ # Output only.
- # A list of warnings, if such are encountered during this scan run.
+ "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", # Output only.
- # Indicates the warning code.
+ "code": "A String", # Indicates the warning code.
},
],
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "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.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "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. # Output only.
- # If result_state is an ERROR, this field provides the primary reason for
+ "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.
- "mostCommonHttpErrorCode": 42, # Output only.
- # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Output only.
- # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
- # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "code": "A String", # Indicates the error reason code.
+ "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.
- "code": "A String", # Output only.
- # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Output only.
- # Indicates the full name of the ScanConfig field that triggers this error,
+ "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.
},
},
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=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
+ 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.
@@ -553,9 +507,6 @@
Allowed values
1 - v1 error format
2 - v2 error format
- 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.
Returns:
An object of the form:
@@ -565,12 +516,15 @@
# more results in the list.
"scanConfigs": [ # The list of ScanConfigs returned.
{ # A ScanConfig resource contains the configurations to launch a scan.
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
# inclusively. If the field is unspecified or its value is set 0, server will
# default to 15. Other values outside of [5, 20] range will be rejected with
# INVALID_ARGUMENT error.
- "displayName": "A String", # Required.
- # The user provided display name of the ScanConfig.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"name": "A String", # The resource name of the ScanConfig. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
# generated by the system.
@@ -579,112 +533,94 @@
# 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.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "riskLevel": "A String", # The risk level selected for the scan
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
# Command Center.
"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
# used as a default.
"A String",
],
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "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.
+ "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).
+ },
+ },
"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", # Input only.
- # Required.
- # The password of the Google account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required.
- # The user name of the custom account.
- "loginUrl": "A String", # Required.
- # The login form URL of the website.
- "password": "A String", # Input only.
- # Required.
- # The password of the custom account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
},
+ "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 Cloud Web Security Scanner, output
+ # only.
"userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required.
- # The starting URLs from which the scanner finds site pages.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
- "warningTraces": [ # Output only.
- # A list of warnings, if such are encountered during this scan run.
+ "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", # Output only.
- # Indicates the warning code.
+ "code": "A String", # Indicates the warning code.
},
],
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "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.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "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. # Output only.
- # If result_state is an ERROR, this field provides the primary reason for
+ "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.
- "mostCommonHttpErrorCode": 42, # Output only.
- # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Output only.
- # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
- # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "code": "A String", # Indicates the error reason code.
+ "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.
- "code": "A String", # Output only.
- # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Output only.
- # Indicates the full name of the ScanConfig field that triggers this error,
+ "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.
},
},
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
},
],
@@ -706,23 +642,26 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<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)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
# inclusively. If the field is unspecified or its value is set 0, server will
# default to 15. Other values outside of [5, 20] range will be rejected with
# INVALID_ARGUMENT error.
- "displayName": "A String", # Required.
- # The user provided display name of the ScanConfig.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"name": "A String", # The resource name of the ScanConfig. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
# generated by the system.
@@ -731,117 +670,98 @@
# 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.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "riskLevel": "A String", # The risk level selected for the scan
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
# Command Center.
"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
# used as a default.
"A String",
],
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "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.
+ "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).
+ },
+ },
"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", # Input only.
- # Required.
- # The password of the Google account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required.
- # The user name of the custom account.
- "loginUrl": "A String", # Required.
- # The login form URL of the website.
- "password": "A String", # Input only.
- # Required.
- # The password of the custom account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
},
+ "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 Cloud Web Security Scanner, output
+ # only.
"userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required.
- # The starting URLs from which the scanner finds site pages.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
- "warningTraces": [ # Output only.
- # A list of warnings, if such are encountered during this scan run.
+ "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", # Output only.
- # Indicates the warning code.
+ "code": "A String", # Indicates the warning code.
},
],
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "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.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "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. # Output only.
- # If result_state is an ERROR, this field provides the primary reason for
+ "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.
- "mostCommonHttpErrorCode": 42, # Output only.
- # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Output only.
- # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
- # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "code": "A String", # Indicates the error reason code.
+ "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.
- "code": "A String", # Output only.
- # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Output only.
- # Indicates the full name of the ScanConfig field that triggers this error,
+ "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.
},
},
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
}
- updateMask: string, Required.
-The update mask applies to the resource. For the `FieldMask` definition,
+ 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.
@@ -853,12 +773,15 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
# inclusively. If the field is unspecified or its value is set 0, server will
# default to 15. Other values outside of [5, 20] range will be rejected with
# INVALID_ARGUMENT error.
- "displayName": "A String", # Required.
- # The user provided display name of the ScanConfig.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"name": "A String", # The resource name of the ScanConfig. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
# generated by the system.
@@ -867,112 +790,94 @@
# 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.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "riskLevel": "A String", # The risk level selected for the scan
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
# Command Center.
"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
# used as a default.
"A String",
],
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "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.
+ "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).
+ },
+ },
"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", # Input only.
- # Required.
- # The password of the Google account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required.
- # The user name of the custom account.
- "loginUrl": "A String", # Required.
- # The login form URL of the website.
- "password": "A String", # Input only.
- # Required.
- # The password of the custom account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
},
+ "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 Cloud Web Security Scanner, output
+ # only.
"userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required.
- # The starting URLs from which the scanner finds site pages.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
- "warningTraces": [ # Output only.
- # A list of warnings, if such are encountered during this scan run.
+ "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", # Output only.
- # Indicates the warning code.
+ "code": "A String", # Indicates the warning code.
},
],
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "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.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "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. # Output only.
- # If result_state is an ERROR, this field provides the primary reason for
+ "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.
- "mostCommonHttpErrorCode": 42, # Output only.
- # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Output only.
- # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
- # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "code": "A String", # Indicates the error reason code.
+ "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.
- "code": "A String", # Output only.
- # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Output only.
- # Indicates the full name of the ScanConfig field that triggers this error,
+ "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.
},
},
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
}</pre>
</div>
@@ -982,8 +887,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
+ 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:
@@ -1001,70 +905,53 @@
{ # A ScanRun is a output-only resource representing an actual run of the scan.
# Next id: 12
- "warningTraces": [ # Output only.
- # A list of warnings, if such are encountered during this scan run.
+ "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", # Output only.
- # Indicates the warning code.
+ "code": "A String", # Indicates the warning code.
},
],
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "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.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "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. # Output only.
- # If result_state is an ERROR, this field provides the primary reason for
+ "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.
- "mostCommonHttpErrorCode": 42, # Output only.
- # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Output only.
- # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
- # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "code": "A String", # Indicates the error reason code.
+ "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.
- "code": "A String", # Output only.
- # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Output only.
- # Indicates the full name of the ScanConfig field that triggers this error,
+ "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.
},
},
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
}</pre>
</div>