docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html
index d4f8db0..b3463ba 100644
--- a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html
@@ -113,55 +113,11 @@
{ # A ScanConfig resource contains the configurations to launch a scan.
# next id: 12
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "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.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs crawled up to now.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs tested up to now. The number of
- # URLs tested is usually larger than the number URLS crawled because
- # typically a crawled URL is tested with multiple test payloads.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "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.
- },
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
- "userAgent": "A String", # The user agent used during scanning.
- "targetPlatforms": [ # Set of 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.
- "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.
"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.
@@ -170,12 +126,56 @@
"username": "A String", # Required. The user name of the Google account.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "username": "A String", # Required. The user name of the 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.
},
},
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ # If the scan is in queue, the value is 0.
+ # If the scan is running, the value ranges from 0 to 100.
+ # If the scan is finished, the value is 100.
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ # the value represents the number of URLs crawled up to now.
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ },
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
+ # refreshed by the server after each run. If unspecified, it will default
+ # to current server time, which means the scan will be scheduled to start
+ # immediately.
+ },
+ "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",
+ ],
+ "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.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+ # generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
+ # will be used as a default.
+ "A String",
+ ],
}
x__xgafv: string, V1 error format.
@@ -188,55 +188,11 @@
{ # A ScanConfig resource contains the configurations to launch a scan.
# next id: 12
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "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.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs crawled up to now.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs tested up to now. The number of
- # URLs tested is usually larger than the number URLS crawled because
- # typically a crawled URL is tested with multiple test payloads.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "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.
- },
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
- "userAgent": "A String", # The user agent used during scanning.
- "targetPlatforms": [ # Set of 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.
- "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.
"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.
@@ -245,12 +201,56 @@
"username": "A String", # Required. The user name of the Google account.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "username": "A String", # Required. The user name of the 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.
},
},
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ # If the scan is in queue, the value is 0.
+ # If the scan is running, the value ranges from 0 to 100.
+ # If the scan is finished, the value is 100.
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ # the value represents the number of URLs crawled up to now.
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ },
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
+ # refreshed by the server after each run. If unspecified, it will default
+ # to current server time, which means the scan will be scheduled to start
+ # immediately.
+ },
+ "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",
+ ],
+ "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.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+ # generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
+ # will be used as a default.
+ "A String",
+ ],
}</pre>
</div>
@@ -298,55 +298,11 @@
{ # A ScanConfig resource contains the configurations to launch a scan.
# next id: 12
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "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.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs crawled up to now.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs tested up to now. The number of
- # URLs tested is usually larger than the number URLS crawled because
- # typically a crawled URL is tested with multiple test payloads.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "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.
- },
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
- "userAgent": "A String", # The user agent used during scanning.
- "targetPlatforms": [ # Set of 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.
- "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.
"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.
@@ -355,12 +311,56 @@
"username": "A String", # Required. The user name of the Google account.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "username": "A String", # Required. The user name of the 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.
},
},
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ # If the scan is in queue, the value is 0.
+ # If the scan is running, the value ranges from 0 to 100.
+ # If the scan is finished, the value is 100.
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ # the value represents the number of URLs crawled up to now.
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ },
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
+ # refreshed by the server after each run. If unspecified, it will default
+ # to current server time, which means the scan will be scheduled to start
+ # immediately.
+ },
+ "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",
+ ],
+ "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.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+ # generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
+ # will be used as a default.
+ "A String",
+ ],
}</pre>
</div>
@@ -386,58 +386,16 @@
An object of the form:
{ # Response for the `ListScanConfigs` method.
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ # more results in the list.
"scanConfigs": [ # The list of ScanConfigs returned.
{ # A ScanConfig resource contains the configurations to launch a scan.
# next id: 12
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "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.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs crawled up to now.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs tested up to now. The number of
- # URLs tested is usually larger than the number URLS crawled because
- # typically a crawled URL is tested with multiple test payloads.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "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.
- },
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
- "userAgent": "A String", # The user agent used during scanning.
- "targetPlatforms": [ # Set of 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.
- "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.
"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.
@@ -446,16 +404,58 @@
"username": "A String", # Required. The user name of the Google account.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "username": "A String", # Required. The user name of the 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.
},
},
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ # If the scan is in queue, the value is 0.
+ # If the scan is running, the value ranges from 0 to 100.
+ # If the scan is finished, the value is 100.
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ # the value represents the number of URLs crawled up to now.
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ },
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
+ # refreshed by the server after each run. If unspecified, it will default
+ # to current server time, which means the scan will be scheduled to start
+ # immediately.
+ },
+ "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",
+ ],
+ "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.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+ # generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
+ # will be used as a default.
+ "A String",
+ ],
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
}</pre>
</div>
@@ -486,55 +486,11 @@
{ # A ScanConfig resource contains the configurations to launch a scan.
# next id: 12
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "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.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs crawled up to now.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs tested up to now. The number of
- # URLs tested is usually larger than the number URLS crawled because
- # typically a crawled URL is tested with multiple test payloads.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "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.
- },
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
- "userAgent": "A String", # The user agent used during scanning.
- "targetPlatforms": [ # Set of 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.
- "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.
"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.
@@ -543,12 +499,56 @@
"username": "A String", # Required. The user name of the Google account.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "username": "A String", # Required. The user name of the 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.
},
},
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ # If the scan is in queue, the value is 0.
+ # If the scan is running, the value ranges from 0 to 100.
+ # If the scan is finished, the value is 100.
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ # the value represents the number of URLs crawled up to now.
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ },
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
+ # refreshed by the server after each run. If unspecified, it will default
+ # to current server time, which means the scan will be scheduled to start
+ # immediately.
+ },
+ "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",
+ ],
+ "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.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+ # generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
+ # will be used as a default.
+ "A String",
+ ],
}
updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition,
@@ -564,55 +564,11 @@
{ # A ScanConfig resource contains the configurations to launch a scan.
# next id: 12
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "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.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs crawled up to now.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs tested up to now. The number of
- # URLs tested is usually larger than the number URLS crawled because
- # typically a crawled URL is tested with multiple test payloads.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "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.
- },
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
- "userAgent": "A String", # The user agent used during scanning.
- "targetPlatforms": [ # Set of 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.
- "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.
"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.
@@ -621,12 +577,56 @@
"username": "A String", # Required. The user name of the Google account.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "username": "A String", # Required. The user name of the 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.
},
},
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ # If the scan is in queue, the value is 0.
+ # If the scan is running, the value ranges from 0 to 100.
+ # If the scan is finished, the value is 100.
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ # the value represents the number of URLs crawled up to now.
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ },
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
+ "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
+ # refreshed by the server after each run. If unspecified, it will default
+ # to current server time, which means the scan will be scheduled to start
+ # immediately.
+ },
+ "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",
+ ],
+ "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.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+ # generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE
+ # will be used as a default.
+ "A String",
+ ],
}</pre>
</div>
@@ -652,26 +652,26 @@
An object of the form:
{ # A ScanRun is a output-only resource representing an actual run of the scan.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "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".
+ "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.
"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.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # The time at which the ScanRun started.
"urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
# the value represents the number of URLs crawled up to now.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
# the value represents the number of URLs tested up to now. The number of
# URLs tested is usually larger than the number URLS crawled because
# typically a crawled URL is tested with multiple test payloads.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "name": "A String", # The resource name of the ScanRun. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
- # The ScanRun IDs are generated by the system.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
}</pre>
</div>