chore: Update discovery artifacts (#1291)
* chore: update docs/dyn/index.md
* chore(abusiveexperiencereport): update the api
* chore(acceleratedmobilepageurl): update the api
* chore(accessapproval): update the api
* chore(accesscontextmanager): update the api
* chore(adexchangebuyer2): update the api
* chore(adexperiencereport): update the api
* chore(admob): update the api
* chore(analytics): update the api
* chore(analyticsreporting): update the api
* chore(androiddeviceprovisioning): update the api
* chore(androidenterprise): update the api
* chore(androidpublisher): update the api
* chore(apigateway): update the api
* chore(artifactregistry): update the api
* chore(bigqueryconnection): update the api
* chore(bigquerydatatransfer): update the api
* chore(billingbudgets): update the api
* chore(binaryauthorization): update the api
* chore(blogger): update the api
* chore(books): update the api
* chore(calendar): update the api
* chore(chat): update the api
* chore(chromeuxreport): update the api
* chore(civicinfo): update the api
* chore(classroom): update the api
* chore(cloudbilling): update the api
* chore(cloudbuild): update the api
* chore(clouddebugger): update the api
* chore(clouderrorreporting): update the api
* chore(cloudfunctions): update the api
* chore(cloudidentity): update the api
* chore(cloudiot): update the api
* chore(cloudkms): update the api
* chore(cloudprofiler): update the api
* chore(cloudresourcemanager): update the api
* chore(cloudscheduler): update the api
* chore(cloudshell): update the api
* chore(cloudtasks): update the api
* chore(cloudtrace): update the api
* chore(composer): update the api
* chore(containeranalysis): update the api
* chore(content): update the api
* chore(customsearch): update the api
* chore(datacatalog): update the api
* chore(datafusion): update the api
* chore(datamigration): update the api
* chore(datastore): update the api
* chore(deploymentmanager): update the api
* chore(digitalassetlinks): update the api
* chore(displayvideo): update the api
* chore(dlp): update the api
* chore(dns): update the api
* chore(docs): update the api
* chore(domains): update the api
* chore(domainsrdap): update the api
* chore(doubleclickbidmanager): update the api
* chore(doubleclicksearch): update the api
* chore(drive): update the api
* chore(driveactivity): update the api
* chore(eventarc): update the api
* chore(factchecktools): update the api
* chore(fcm): update the api
* chore(file): update the api
* chore(firebase): update the api
* chore(firebasedatabase): update the api
* chore(firebasedynamiclinks): update the api
* chore(firebasehosting): update the api
* chore(firebaseml): update the api
* chore(firebaserules): update the api
* chore(firestore): update the api
* chore(fitness): update the api
* chore(gamesConfiguration): update the api
* chore(gamesManagement): update the api
* chore(gameservices): update the api
* chore(genomics): update the api
* chore(gmail): update the api
* chore(gmailpostmastertools): update the api
* chore(groupsmigration): update the api
* chore(groupssettings): update the api
* chore(healthcare): update the api
* chore(iam): update the api
* chore(iamcredentials): update the api
* chore(iap): update the api
* chore(identitytoolkit): update the api
* chore(indexing): update the api
* chore(jobs): update the api
* chore(kgsearch): update the api
* chore(language): update the api
* chore(libraryagent): update the api
* chore(licensing): update the api
* chore(lifesciences): update the api
* chore(logging): update the api
* chore(managedidentities): update the api
* chore(manufacturers): update the api
* chore(memcache): update the api
* chore(ml): update the api
* chore(monitoring): update the api
* chore(networkmanagement): update the api
* chore(osconfig): update the api
* chore(pagespeedonline): update the api
* chore(playablelocations): update the api
* chore(playcustomapp): update the api
* chore(policytroubleshooter): update the api
* chore(poly): update the api
* chore(privateca): update the api
* chore(prod_tt_sasportal): update the api
* chore(pubsub): update the api
* chore(pubsublite): update the api
* chore(realtimebidding): update the api
* chore(recommendationengine): update the api
* chore(recommender): update the api
* chore(redis): update the api
* chore(remotebuildexecution): update the api
* chore(reseller): update the api
* chore(runtimeconfig): update the api
* chore(safebrowsing): update the api
* chore(sasportal): update the api
* chore(script): update the api
* chore(searchconsole): update the api
* chore(secretmanager): update the api
* chore(servicecontrol): update the api
* chore(servicedirectory): update the api
* chore(siteVerification): update the api
* chore(slides): update the api
* chore(smartdevicemanagement): update the api
* chore(sourcerepo): update the api
* chore(sqladmin): update the api
* chore(storage): update the api
* chore(storagetransfer): update the api
* chore(streetviewpublish): update the api
* chore(sts): update the api
* chore(tagmanager): update the api
* chore(tasks): update the api
* chore(testing): update the api
* chore(texttospeech): update the api
* chore(toolresults): update the api
* chore(trafficdirector): update the api
* chore(transcoder): update the api
* chore(translate): update the api
* chore(vault): update the api
* chore(vectortile): update the api
* chore(verifiedaccess): update the api
* chore(videointelligence): update the api
* chore(vision): update the api
* chore(webfonts): update the api
* chore(webmasters): update the api
* chore(websecurityscanner): update the api
* chore(workflowexecutions): update the api
* chore(workflows): update the api
* chore(youtubeAnalytics): update the api
* chore(youtubereporting): update the api
* chore(docs): Add new discovery artifacts and reference documents
diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json
index 9737a98..d45c271 100644
--- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json
@@ -1,106 +1,610 @@
{
- "schemas": {
- "ScanRun": {
- "id": "ScanRun",
- "description": "A ScanRun is a output-only resource representing an actual run of the scan.",
- "type": "object",
- "properties": {
- "resultState": {
- "type": "string",
- "enum": [
- "RESULT_STATE_UNSPECIFIED",
- "SUCCESS",
- "ERROR",
- "KILLED"
- ],
- "description": "The result state of the ScanRun. This field is only available after the execution state reaches \"FINISHED\".",
- "enumDescriptions": [
- "Default value. This value is returned when the ScanRun is not yet finished.",
- "The scan finished without errors.",
- "The scan finished with errors.",
- "The scan was terminated by user."
- ]
- },
- "executionState": {
- "enumDescriptions": [
- "Represents an invalid state caused by internal server error. This value should never be returned.",
- "The scan is waiting in the queue.",
- "The scan is in progress.",
- "The scan is either finished or stopped by user."
- ],
- "description": "The execution state of the ScanRun.",
- "type": "string",
- "enum": [
- "EXECUTION_STATE_UNSPECIFIED",
- "QUEUED",
- "SCANNING",
- "FINISHED"
- ]
- },
- "urlsTestedCount": {
- "type": "string",
- "format": "int64",
- "description": "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."
- },
- "hasVulnerabilities": {
- "description": "Whether the scan run has found any vulnerabilities.",
- "type": "boolean"
- },
- "startTime": {
- "type": "string",
- "description": "The time at which the ScanRun started.",
- "format": "google-datetime"
- },
- "progressPercent": {
- "type": "integer",
- "format": "int32",
- "description": "The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100."
- },
- "name": {
- "type": "string",
- "description": "The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system."
- },
- "urlsCrawledCount": {
- "description": "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.",
- "format": "int64",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "type": "string",
- "description": "The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user."
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "See, edit, configure, and delete your Google Cloud Platform data"
}
}
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://websecurityscanner.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "WebSecurityScanner",
+ "description": "Scans your Compute and App Engine apps for common web vulnerabilities.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "websecurityscanner:v1alpha",
+ "kind": "discovery#restDescription",
+ "mtlsRootUrl": "https://websecurityscanner.mtls.googleapis.com/",
+ "name": "websecurityscanner",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
- "StopScanRunRequest": {
- "id": "StopScanRunRequest",
- "properties": {},
- "description": "Request for the `StopScanRun` method.",
- "type": "object"
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
},
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "projects": {
+ "resources": {
+ "scanConfigs": {
+ "methods": {
+ "create": {
+ "description": "Creates a new ScanConfig.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs",
+ "httpMethod": "POST",
+ "id": "websecurityscanner.projects.scanConfigs.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+parent}/scanConfigs",
+ "request": {
+ "$ref": "ScanConfig"
+ },
+ "response": {
+ "$ref": "ScanConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes an existing ScanConfig and its child resources.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}",
+ "httpMethod": "DELETE",
+ "id": "websecurityscanner.projects.scanConfigs.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets a ScanConfig.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}",
+ "httpMethod": "GET",
+ "id": "websecurityscanner.projects.scanConfigs.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+name}",
+ "response": {
+ "$ref": "ScanConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists ScanConfigs under a given project.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs",
+ "httpMethod": "GET",
+ "id": "websecurityscanner.projects.scanConfigs.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+parent}/scanConfigs",
+ "response": {
+ "$ref": "ListScanConfigsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "description": "Updates a ScanConfig. This method support partial update of a ScanConfig.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}",
+ "httpMethod": "PATCH",
+ "id": "websecurityscanner.projects.scanConfigs.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+name}",
+ "request": {
+ "$ref": "ScanConfig"
+ },
+ "response": {
+ "$ref": "ScanConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "start": {
+ "description": "Start a ScanRun according to the given ScanConfig.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}:start",
+ "httpMethod": "POST",
+ "id": "websecurityscanner.projects.scanConfigs.start",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+name}:start",
+ "request": {
+ "$ref": "StartScanRunRequest"
+ },
+ "response": {
+ "$ref": "ScanRun"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "scanRuns": {
+ "methods": {
+ "get": {
+ "description": "Gets a ScanRun.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}",
+ "httpMethod": "GET",
+ "id": "websecurityscanner.projects.scanConfigs.scanRuns.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+name}",
+ "response": {
+ "$ref": "ScanRun"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns",
+ "httpMethod": "GET",
+ "id": "websecurityscanner.projects.scanConfigs.scanRuns.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+parent}/scanRuns",
+ "response": {
+ "$ref": "ListScanRunsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "stop": {
+ "description": "Stops a ScanRun. The stopped ScanRun is returned.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}:stop",
+ "httpMethod": "POST",
+ "id": "websecurityscanner.projects.scanConfigs.scanRuns.stop",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+name}:stop",
+ "request": {
+ "$ref": "StopScanRunRequest"
+ },
+ "response": {
+ "$ref": "ScanRun"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "crawledUrls": {
+ "methods": {
+ "list": {
+ "description": "List CrawledUrls under a given ScanRun.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/crawledUrls",
+ "httpMethod": "GET",
+ "id": "websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+parent}/crawledUrls",
+ "response": {
+ "$ref": "ListCrawledUrlsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "findingTypeStats": {
+ "methods": {
+ "list": {
+ "description": "List all FindingTypeStats under a given ScanRun.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats",
+ "httpMethod": "GET",
+ "id": "websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+parent}/findingTypeStats",
+ "response": {
+ "$ref": "ListFindingTypeStatsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "findings": {
+ "methods": {
+ "get": {
+ "description": "Gets a Finding.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings/{findingsId}",
+ "httpMethod": "GET",
+ "id": "websecurityscanner.projects.scanConfigs.scanRuns.findings.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+/findings/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+name}",
+ "response": {
+ "$ref": "Finding"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "List Findings under a given ScanRun.",
+ "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings",
+ "httpMethod": "GET",
+ "id": "websecurityscanner.projects.scanConfigs.scanRuns.findings.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/{+parent}/findings",
+ "response": {
+ "$ref": "ListFindingsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20210408",
+ "rootUrl": "https://websecurityscanner.googleapis.com/",
+ "schemas": {
"Authentication": {
- "type": "object",
"description": "Scan authentication configuration.",
"id": "Authentication",
"properties": {
- "googleAccount": {
- "$ref": "GoogleAccount",
- "description": "Authentication using a Google account."
- },
"customAccount": {
"$ref": "CustomAccount",
"description": "Authentication using a custom account."
+ },
+ "googleAccount": {
+ "$ref": "GoogleAccount",
+ "description": "Authentication using a Google account."
}
- }
+ },
+ "type": "object"
+ },
+ "CrawledUrl": {
+ "description": "A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against.",
+ "id": "CrawledUrl",
+ "properties": {
+ "body": {
+ "description": "Output only. The body of the request that was used to visit the URL.",
+ "type": "string"
+ },
+ "httpMethod": {
+ "description": "Output only. The http method of the request that was used to visit the URL, in uppercase.",
+ "type": "string"
+ },
+ "url": {
+ "description": "Output only. The URL that was crawled.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomAccount": {
+ "description": "Describes authentication configuration that uses a custom account.",
+ "id": "CustomAccount",
+ "properties": {
+ "loginUrl": {
+ "description": "Required. The login form URL of the website.",
+ "type": "string"
+ },
+ "password": {
+ "description": "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.",
+ "type": "string"
+ },
+ "username": {
+ "description": "Required. The user name of the custom account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
},
"Finding": {
+ "description": "A Finding resource represents a vulnerability instance identified during a ScanRun.",
+ "id": "Finding",
"properties": {
- "name": {
- "description": "The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system.",
+ "body": {
+ "description": "The body of the request that triggered the vulnerability.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The description of the vulnerability.",
+ "type": "string"
+ },
+ "finalUrl": {
+ "description": "The URL where the browser lands when the vulnerability is detected.",
"type": "string"
},
"findingType": {
- "type": "string",
"description": "The type of the Finding.",
"enum": [
"FINDING_TYPE_UNSPECIFIED",
@@ -129,395 +633,66 @@
"A malformed or invalid valued header.",
"Misspelled security header name.",
"Mismatching values in a duplicate security header."
- ]
- },
- "finalUrl": {
- "description": "The URL where the browser lands when the vulnerability is detected.",
+ ],
"type": "string"
},
- "reproductionUrl": {
- "description": "The URL containing human-readable payload that user can leverage to reproduce the vulnerability.",
- "type": "string"
- },
- "outdatedLibrary": {
- "description": "An addon containing information about outdated libraries.",
- "$ref": "OutdatedLibrary"
- },
- "xss": {
- "description": "An addon containing information reported for an XSS, if any.",
- "$ref": "Xss"
- },
"frameUrl": {
- "type": "string",
- "description": "If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported."
- },
- "vulnerableParameters": {
- "$ref": "VulnerableParameters",
- "description": "An addon containing information about request parameters which were found to be vulnerable."
- },
- "httpMethod": {
- "description": "The http method of the request that triggered the vulnerability, in uppercase.",
- "type": "string"
- },
- "body": {
- "type": "string",
- "description": "The body of the request that triggered the vulnerability."
- },
- "violatingResource": {
- "description": "An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.",
- "$ref": "ViolatingResource"
- },
- "description": {
- "description": "The description of the vulnerability.",
+ "description": "If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.",
"type": "string"
},
"fuzzedUrl": {
"description": "The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.",
"type": "string"
},
- "vulnerableHeaders": {
- "description": "An addon containing information about vulnerable or missing HTTP headers.",
- "$ref": "VulnerableHeaders"
+ "httpMethod": {
+ "description": "The http method of the request that triggered the vulnerability, in uppercase.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system.",
+ "type": "string"
+ },
+ "outdatedLibrary": {
+ "$ref": "OutdatedLibrary",
+ "description": "An addon containing information about outdated libraries."
+ },
+ "reproductionUrl": {
+ "description": "The URL containing human-readable payload that user can leverage to reproduce the vulnerability.",
+ "type": "string"
},
"trackingId": {
"description": "The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.",
"type": "string"
- }
- },
- "description": "A Finding resource represents a vulnerability instance identified during a ScanRun.",
- "type": "object",
- "id": "Finding"
- },
- "GoogleAccount": {
- "properties": {
- "password": {
- "type": "string",
- "description": "Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs."
},
- "username": {
- "type": "string",
- "description": "Required. The user name of the Google account."
- }
- },
- "id": "GoogleAccount",
- "type": "object",
- "description": "Describes authentication configuration that uses a Google account."
- },
- "VulnerableParameters": {
- "type": "object",
- "properties": {
- "parameterNames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The vulnerable parameter names."
- }
- },
- "description": "Information about vulnerable request parameters.",
- "id": "VulnerableParameters"
- },
- "ScanConfig": {
- "id": "ScanConfig",
- "type": "object",
- "properties": {
- "maxQps": {
- "description": "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.",
- "type": "integer",
- "format": "int32"
+ "violatingResource": {
+ "$ref": "ViolatingResource",
+ "description": "An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc."
},
- "schedule": {
- "description": "The schedule of the ScanConfig.",
- "$ref": "Schedule"
+ "vulnerableHeaders": {
+ "$ref": "VulnerableHeaders",
+ "description": "An addon containing information about vulnerable or missing HTTP headers."
},
- "latestRun": {
- "description": "Latest ScanRun if available.",
- "$ref": "ScanRun"
+ "vulnerableParameters": {
+ "$ref": "VulnerableParameters",
+ "description": "An addon containing information about request parameters which were found to be vulnerable."
},
- "targetPlatforms": {
- "items": {
- "enumDescriptions": [
- "The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.",
- "Google App Engine service.",
- "Google Compute Engine service."
- ],
- "enum": [
- "TARGET_PLATFORM_UNSPECIFIED",
- "APP_ENGINE",
- "COMPUTE"
- ],
- "type": "string"
- },
- "type": "array",
- "description": "Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default."
- },
- "startingUrls": {
- "description": "Required. The starting URLs from which the scanner finds site pages.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "authentication": {
- "description": "The authentication configuration. If specified, service will use the authentication configuration during scanning.",
- "$ref": "Authentication"
- },
- "userAgent": {
- "description": "The user agent used during scanning.",
- "enumDescriptions": [
- "The user agent is unknown. Service will default to CHROME_LINUX.",
- "Chrome on Linux. This is the service default if unspecified.",
- "Chrome on Android.",
- "Safari on IPhone."
- ],
- "enum": [
- "USER_AGENT_UNSPECIFIED",
- "CHROME_LINUX",
- "CHROME_ANDROID",
- "SAFARI_IPHONE"
- ],
- "type": "string"
- },
- "displayName": {
- "type": "string",
- "description": "Required. The user provided display name of the ScanConfig."
- },
- "name": {
- "description": "The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.",
- "type": "string"
- },
- "blacklistPatterns": {
- "description": "The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "description": "A ScanConfig resource contains the configurations to launch a scan. next id: 12"
- },
- "Header": {
- "description": "Describes a HTTP Header.",
- "id": "Header",
- "properties": {
- "value": {
- "description": "Header value.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "Header name."
+ "xss": {
+ "$ref": "Xss",
+ "description": "An addon containing information reported for an XSS, if any."
}
},
"type": "object"
},
- "ViolatingResource": {
- "type": "object",
- "description": "Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.",
- "id": "ViolatingResource",
- "properties": {
- "resourceUrl": {
- "description": "URL of this violating resource.",
- "type": "string"
- },
- "contentType": {
- "type": "string",
- "description": "The MIME type of this resource."
- }
- }
- },
- "StartScanRunRequest": {
- "description": "Request for the `StartScanRun` method.",
- "id": "StartScanRunRequest",
- "properties": {},
- "type": "object"
- },
- "Schedule": {
- "description": "Scan schedule configuration.",
- "type": "object",
- "properties": {
- "intervalDurationDays": {
- "type": "integer",
- "format": "int32",
- "description": "Required. The duration of time between executions in days."
- },
- "scheduleTime": {
- "description": "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.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Schedule"
- },
- "VulnerableHeaders": {
- "properties": {
- "missingHeaders": {
- "description": "List of missing headers.",
- "items": {
- "$ref": "Header"
- },
- "type": "array"
- },
- "headers": {
- "description": "List of vulnerable headers.",
- "items": {
- "$ref": "Header"
- },
- "type": "array"
- }
- },
- "id": "VulnerableHeaders",
- "description": "Information about vulnerable or missing HTTP Headers.",
- "type": "object"
- },
- "Empty": {
- "type": "object",
- "properties": {},
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
- "id": "Empty"
- },
- "ListFindingsResponse": {
- "type": "object",
- "id": "ListFindingsResponse",
- "properties": {
- "findings": {
- "description": "The list of Findings returned.",
- "type": "array",
- "items": {
- "$ref": "Finding"
- }
- },
- "nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
- "type": "string"
- }
- },
- "description": "Response for the `ListFindings` method."
- },
- "OutdatedLibrary": {
- "description": "Information reported for an outdated library.",
- "id": "OutdatedLibrary",
- "type": "object",
- "properties": {
- "learnMoreUrls": {
- "description": "URLs to learn more information about the vulnerabilities in the library.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "libraryName": {
- "description": "The name of the outdated library.",
- "type": "string"
- },
- "version": {
- "type": "string",
- "description": "The version number."
- }
- }
- },
- "CrawledUrl": {
- "description": "A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against.",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "description": "Output only. The URL that was crawled."
- },
- "body": {
- "type": "string",
- "description": "Output only. The body of the request that was used to visit the URL."
- },
- "httpMethod": {
- "description": "Output only. The http method of the request that was used to visit the URL, in uppercase.",
- "type": "string"
- }
- },
- "id": "CrawledUrl"
- },
- "ListScanRunsResponse": {
- "type": "object",
- "id": "ListScanRunsResponse",
- "description": "Response for the `ListScanRuns` method.",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "Token to retrieve the next page of results, or empty if there are no more results in the list."
- },
- "scanRuns": {
- "type": "array",
- "description": "The list of ScanRuns returned.",
- "items": {
- "$ref": "ScanRun"
- }
- }
- }
- },
- "Xss": {
- "id": "Xss",
- "description": "Information reported for an XSS.",
- "properties": {
- "stackTraces": {
- "type": "array",
- "description": "Stack traces leading to the point where the XSS occurred.",
- "items": {
- "type": "string"
- }
- },
- "errorMessage": {
- "type": "string",
- "description": "An error message generated by a javascript breakage."
- }
- },
- "type": "object"
- },
- "ListScanConfigsResponse": {
- "id": "ListScanConfigsResponse",
- "properties": {
- "scanConfigs": {
- "items": {
- "$ref": "ScanConfig"
- },
- "description": "The list of ScanConfigs returned.",
- "type": "array"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token to retrieve the next page of results, or empty if there are no more results in the list."
- }
- },
- "description": "Response for the `ListScanConfigs` method.",
- "type": "object"
- },
- "ListCrawledUrlsResponse": {
- "type": "object",
- "description": "Response for the `ListCrawledUrls` method.",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "Token to retrieve the next page of results, or empty if there are no more results in the list."
- },
- "crawledUrls": {
- "description": "The list of CrawledUrls returned.",
- "items": {
- "$ref": "CrawledUrl"
- },
- "type": "array"
- }
- },
- "id": "ListCrawledUrlsResponse"
- },
"FindingTypeStats": {
"description": "A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.",
- "type": "object",
+ "id": "FindingTypeStats",
"properties": {
"findingCount": {
- "type": "integer",
+ "description": "The count of findings belonging to this finding type.",
"format": "int32",
- "description": "The count of findings belonging to this finding type."
+ "type": "integer"
},
"findingType": {
- "type": "string",
"description": "The finding type associated with the stats.",
"enum": [
"FINDING_TYPE_UNSPECIFIED",
@@ -546,576 +721,401 @@
"A malformed or invalid valued header.",
"Misspelled security header name.",
"Mismatching values in a duplicate security header."
- ]
+ ],
+ "type": "string"
}
},
- "id": "FindingTypeStats"
+ "type": "object"
},
- "CustomAccount": {
- "description": "Describes authentication configuration that uses a custom account.",
- "type": "object",
+ "GoogleAccount": {
+ "description": "Describes authentication configuration that uses a Google account.",
+ "id": "GoogleAccount",
"properties": {
- "loginUrl": {
- "description": "Required. The login form URL of the website.",
+ "password": {
+ "description": "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.",
"type": "string"
},
"username": {
- "description": "Required. The user name of the custom account.",
+ "description": "Required. The user name of the Google account.",
"type": "string"
- },
- "password": {
- "type": "string",
- "description": "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."
}
},
- "id": "CustomAccount"
+ "type": "object"
+ },
+ "Header": {
+ "description": "Describes a HTTP Header.",
+ "id": "Header",
+ "properties": {
+ "name": {
+ "description": "Header name.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Header value.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListCrawledUrlsResponse": {
+ "description": "Response for the `ListCrawledUrls` method.",
+ "id": "ListCrawledUrlsResponse",
+ "properties": {
+ "crawledUrls": {
+ "description": "The list of CrawledUrls returned.",
+ "items": {
+ "$ref": "CrawledUrl"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"ListFindingTypeStatsResponse": {
+ "description": "Response for the `ListFindingTypeStats` method.",
"id": "ListFindingTypeStatsResponse",
"properties": {
"findingTypeStats": {
- "type": "array",
+ "description": "The list of FindingTypeStats returned.",
"items": {
"$ref": "FindingTypeStats"
},
- "description": "The list of FindingTypeStats returned."
+ "type": "array"
}
},
- "type": "object",
- "description": "Response for the `ListFindingTypeStats` method."
- }
- },
- "canonicalName": "WebSecurityScanner",
- "resources": {
- "projects": {
- "resources": {
- "scanConfigs": {
- "methods": {
- "delete": {
- "description": "Deletes an existing ScanConfig and its child resources.",
- "id": "websecurityscanner.projects.scanConfigs.delete",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "path": "v1alpha/{+name}",
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "description": "Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.",
- "pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}"
- },
- "start": {
- "response": {
- "$ref": "ScanRun"
- },
- "request": {
- "$ref": "StartScanRunRequest"
- },
- "id": "websecurityscanner.projects.scanConfigs.start",
- "parameters": {
- "name": {
- "location": "path",
- "required": true,
- "pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
- "type": "string",
- "description": "Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'."
- }
- },
- "description": "Start a ScanRun according to the given ScanConfig.",
- "path": "v1alpha/{+name}:start",
- "parameterOrder": [
- "name"
- ],
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}:start",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "httpMethod": "POST"
- },
- "patch": {
- "description": "Updates a ScanConfig. This method support partial update of a ScanConfig.",
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "type": "string",
- "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
- "location": "query"
- },
- "name": {
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
- "description": "The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system."
- }
- },
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}",
- "request": {
- "$ref": "ScanConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "path": "v1alpha/{+name}",
- "id": "websecurityscanner.projects.scanConfigs.patch",
- "response": {
- "$ref": "ScanConfig"
- },
- "parameterOrder": [
- "name"
- ]
- },
- "create": {
- "id": "websecurityscanner.projects.scanConfigs.create",
- "parameterOrder": [
- "parent"
- ],
- "description": "Creates a new ScanConfig.",
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs",
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "required": true,
- "description": "Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "path": "v1alpha/{+parent}/scanConfigs",
- "response": {
- "$ref": "ScanConfig"
- },
- "request": {
- "$ref": "ScanConfig"
- }
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ScanConfig"
- },
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}",
- "parameters": {
- "name": {
- "description": "Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
- "location": "path"
- }
- },
- "id": "websecurityscanner.projects.scanConfigs.get",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameterOrder": [
- "name"
- ],
- "path": "v1alpha/{+name}",
- "description": "Gets a ScanConfig."
- },
- "list": {
- "parameters": {
- "parent": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'.",
- "pattern": "^projects/[^/]+$"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "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.",
- "format": "int32"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "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."
- }
- },
- "response": {
- "$ref": "ListScanConfigsResponse"
- },
- "description": "Lists ScanConfigs under a given project.",
- "id": "websecurityscanner.projects.scanConfigs.list",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "path": "v1alpha/{+parent}/scanConfigs",
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
+ "type": "object"
+ },
+ "ListFindingsResponse": {
+ "description": "Response for the `ListFindings` method.",
+ "id": "ListFindingsResponse",
+ "properties": {
+ "findings": {
+ "description": "The list of Findings returned.",
+ "items": {
+ "$ref": "Finding"
},
- "resources": {
- "scanRuns": {
- "resources": {
- "crawledUrls": {
- "methods": {
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "httpMethod": "GET",
- "description": "List CrawledUrls under a given ScanRun.",
- "path": "v1alpha/{+parent}/crawledUrls",
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/crawledUrls",
- "id": "websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list",
- "parameters": {
- "pageSize": {
- "location": "query",
- "type": "integer",
- "format": "int32",
- "description": "The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value."
- },
- "parent": {
- "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
- "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageToken": {
- "description": "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.",
- "location": "query",
- "type": "string"
- }
- },
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListCrawledUrlsResponse"
- }
- }
- }
- },
- "findingTypeStats": {
- "methods": {
- "list": {
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats",
- "parameterOrder": [
- "parent"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "httpMethod": "GET",
- "id": "websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list",
- "path": "v1alpha/{+parent}/findingTypeStats",
- "response": {
- "$ref": "ListFindingTypeStatsResponse"
- },
- "parameters": {
- "parent": {
- "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
- "required": true,
- "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
- "type": "string",
- "location": "path"
- }
- },
- "description": "List all FindingTypeStats under a given ScanRun."
- }
- }
- },
- "findings": {
- "methods": {
- "list": {
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "ListFindingsResponse"
- },
- "parameters": {
- "pageToken": {
- "description": "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.",
- "location": "query",
- "type": "string"
- },
- "parent": {
- "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
- "location": "path",
- "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.",
- "location": "query",
- "type": "string"
- }
- },
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings",
- "description": "List Findings under a given ScanRun.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "id": "websecurityscanner.projects.scanConfigs.scanRuns.findings.list",
- "path": "v1alpha/{+parent}/findings"
- },
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "response": {
- "$ref": "Finding"
- },
- "parameters": {
- "name": {
- "required": true,
- "location": "path",
- "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+/findings/[^/]+$",
- "type": "string",
- "description": "Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'."
- }
- },
- "parameterOrder": [
- "name"
- ],
- "path": "v1alpha/{+name}",
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings/{findingsId}",
- "httpMethod": "GET",
- "id": "websecurityscanner.projects.scanConfigs.scanRuns.findings.get",
- "description": "Gets a Finding."
- }
- }
- }
- },
- "methods": {
- "stop": {
- "id": "websecurityscanner.projects.scanConfigs.scanRuns.stop",
- "parameters": {
- "name": {
- "type": "string",
- "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
- "description": "Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
- "required": true,
- "location": "path"
- }
- },
- "description": "Stops a ScanRun. The stopped ScanRun is returned.",
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}:stop",
- "response": {
- "$ref": "ScanRun"
- },
- "path": "v1alpha/{+name}:stop",
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "request": {
- "$ref": "StopScanRunRequest"
- },
- "httpMethod": "POST"
- },
- "list": {
- "parameterOrder": [
- "parent"
- ],
- "path": "v1alpha/{+parent}/scanRuns",
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned."
- },
- "pageSize": {
- "description": "The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'.",
- "location": "path",
- "pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "description": "Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.",
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns",
- "id": "websecurityscanner.projects.scanConfigs.scanRuns.list",
- "response": {
- "$ref": "ListScanRunsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$"
- }
- },
- "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}",
- "response": {
- "$ref": "ScanRun"
- },
- "httpMethod": "GET",
- "description": "Gets a ScanRun.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "id": "websecurityscanner.projects.scanConfigs.scanRuns.get",
- "path": "v1alpha/{+name}",
- "parameterOrder": [
- "name"
- ]
- }
- }
- }
- }
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
+ "type": "string"
}
- }
- }
- },
- "fullyEncodeReservedExpansion": true,
- "batchPath": "batch",
- "discoveryVersion": "v1",
- "title": "Web Security Scanner API",
- "version_module": true,
- "basePath": "",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "protocol": "rest",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "type": "object"
+ },
+ "ListScanConfigsResponse": {
+ "description": "Response for the `ListScanConfigs` method.",
+ "id": "ListScanConfigsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
+ "type": "string"
+ },
+ "scanConfigs": {
+ "description": "The list of ScanConfigs returned.",
+ "items": {
+ "$ref": "ScanConfig"
+ },
+ "type": "array"
}
- }
+ },
+ "type": "object"
+ },
+ "ListScanRunsResponse": {
+ "description": "Response for the `ListScanRuns` method.",
+ "id": "ListScanRunsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
+ "type": "string"
+ },
+ "scanRuns": {
+ "description": "The list of ScanRuns returned.",
+ "items": {
+ "$ref": "ScanRun"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OutdatedLibrary": {
+ "description": "Information reported for an outdated library.",
+ "id": "OutdatedLibrary",
+ "properties": {
+ "learnMoreUrls": {
+ "description": "URLs to learn more information about the vulnerabilities in the library.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "libraryName": {
+ "description": "The name of the outdated library.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version number.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ScanConfig": {
+ "description": "A ScanConfig resource contains the configurations to launch a scan. next id: 12",
+ "id": "ScanConfig",
+ "properties": {
+ "authentication": {
+ "$ref": "Authentication",
+ "description": "The authentication configuration. If specified, service will use the authentication configuration during scanning."
+ },
+ "blacklistPatterns": {
+ "description": "The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "displayName": {
+ "description": "Required. The user provided display name of the ScanConfig.",
+ "type": "string"
+ },
+ "latestRun": {
+ "$ref": "ScanRun",
+ "description": "Latest ScanRun if available."
+ },
+ "maxQps": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.",
+ "type": "string"
+ },
+ "schedule": {
+ "$ref": "Schedule",
+ "description": "The schedule of the ScanConfig."
+ },
+ "startingUrls": {
+ "description": "Required. The starting URLs from which the scanner finds site pages.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "targetPlatforms": {
+ "description": "Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.",
+ "items": {
+ "enum": [
+ "TARGET_PLATFORM_UNSPECIFIED",
+ "APP_ENGINE",
+ "COMPUTE"
+ ],
+ "enumDescriptions": [
+ "The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.",
+ "Google App Engine service.",
+ "Google Compute Engine service."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "userAgent": {
+ "description": "The user agent used during scanning.",
+ "enum": [
+ "USER_AGENT_UNSPECIFIED",
+ "CHROME_LINUX",
+ "CHROME_ANDROID",
+ "SAFARI_IPHONE"
+ ],
+ "enumDescriptions": [
+ "The user agent is unknown. Service will default to CHROME_LINUX.",
+ "Chrome on Linux. This is the service default if unspecified.",
+ "Chrome on Android.",
+ "Safari on IPhone."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ScanRun": {
+ "description": "A ScanRun is a output-only resource representing an actual run of the scan.",
+ "id": "ScanRun",
+ "properties": {
+ "endTime": {
+ "description": "The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "executionState": {
+ "description": "The execution state of the ScanRun.",
+ "enum": [
+ "EXECUTION_STATE_UNSPECIFIED",
+ "QUEUED",
+ "SCANNING",
+ "FINISHED"
+ ],
+ "enumDescriptions": [
+ "Represents an invalid state caused by internal server error. This value should never be returned.",
+ "The scan is waiting in the queue.",
+ "The scan is in progress.",
+ "The scan is either finished or stopped by user."
+ ],
+ "type": "string"
+ },
+ "hasVulnerabilities": {
+ "description": "Whether the scan run has found any vulnerabilities.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "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.",
+ "type": "string"
+ },
+ "progressPercent": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "resultState": {
+ "description": "The result state of the ScanRun. This field is only available after the execution state reaches \"FINISHED\".",
+ "enum": [
+ "RESULT_STATE_UNSPECIFIED",
+ "SUCCESS",
+ "ERROR",
+ "KILLED"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is returned when the ScanRun is not yet finished.",
+ "The scan finished without errors.",
+ "The scan finished with errors.",
+ "The scan was terminated by user."
+ ],
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The time at which the ScanRun started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "urlsCrawledCount": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "urlsTestedCount": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Schedule": {
+ "description": "Scan schedule configuration.",
+ "id": "Schedule",
+ "properties": {
+ "intervalDurationDays": {
+ "description": "Required. The duration of time between executions in days.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "scheduleTime": {
+ "description": "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.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "StartScanRunRequest": {
+ "description": "Request for the `StartScanRun` method.",
+ "id": "StartScanRunRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "StopScanRunRequest": {
+ "description": "Request for the `StopScanRun` method.",
+ "id": "StopScanRunRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "ViolatingResource": {
+ "description": "Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.",
+ "id": "ViolatingResource",
+ "properties": {
+ "contentType": {
+ "description": "The MIME type of this resource.",
+ "type": "string"
+ },
+ "resourceUrl": {
+ "description": "URL of this violating resource.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "VulnerableHeaders": {
+ "description": "Information about vulnerable or missing HTTP Headers.",
+ "id": "VulnerableHeaders",
+ "properties": {
+ "headers": {
+ "description": "List of vulnerable headers.",
+ "items": {
+ "$ref": "Header"
+ },
+ "type": "array"
+ },
+ "missingHeaders": {
+ "description": "List of missing headers.",
+ "items": {
+ "$ref": "Header"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "VulnerableParameters": {
+ "description": "Information about vulnerable request parameters.",
+ "id": "VulnerableParameters",
+ "properties": {
+ "parameterNames": {
+ "description": "The vulnerable parameter names.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Xss": {
+ "description": "Information reported for an XSS.",
+ "id": "Xss",
+ "properties": {
+ "errorMessage": {
+ "description": "An error message generated by a javascript breakage.",
+ "type": "string"
+ },
+ "stackTraces": {
+ "description": "Stack traces leading to the point where the XSS occurred.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
}
},
- "parameters": {
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query"
- },
- "alt": {
- "location": "query",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ]
- },
- "prettyPrint": {
- "location": "query",
- "default": "true",
- "type": "boolean",
- "description": "Returns response with indentations and line breaks."
- },
- "fields": {
- "location": "query",
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "$.xgafv": {
- "location": "query",
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "enum": [
- "1",
- "2"
- ]
- },
- "uploadType": {
- "location": "query",
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- }
- },
- "version": "v1alpha",
- "revision": "20200826",
- "documentationLink": "https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/",
- "description": "Scans your Compute and App Engine apps for common web vulnerabilities.",
- "mtlsRootUrl": "https://websecurityscanner.mtls.googleapis.com/",
- "rootUrl": "https://websecurityscanner.googleapis.com/",
- "kind": "discovery#restDescription",
- "name": "websecurityscanner",
"servicePath": "",
- "ownerName": "Google",
- "ownerDomain": "google.com",
- "baseUrl": "https://websecurityscanner.googleapis.com/",
- "id": "websecurityscanner:v1alpha"
-}
+ "title": "Web Security Scanner API",
+ "version": "v1alpha",
+ "version_module": true
+}
\ No newline at end of file