luzifer/nginx-sso
1
0
Fork 0
mirror of https://github.com/Luzifer/nginx-sso.git synced 2024-12-21 05:11:17 +00:00
Code Issues Releases Wiki Activity
nginx-sso/vendor/google.golang.org/api/websecurityscanner/v1beta/websecurityscanner-api.json

1279 lines
54 KiB
JSON
Raw Normal View History

Update dependencies Signed-off-by: Knut Ahlers <knut@ahlers.me>
2019-04-21 17:58:15 +00:00
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"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-scanner/",
"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:v1beta",
"kind": "discovery#restDescription",
"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"
},
"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": "v1beta/projects/{projectsId}/scanConfigs",
"httpMethod": "POST",
"id": "websecurityscanner.projects.scanConfigs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required.\nThe parent resource name where the scan is created, which should be a\nproject resource name in the format 'projects/{projectId}'.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+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": "v1beta/projects/{projectsId}/scanConfigs/{scanConfigsId}",
"httpMethod": "DELETE",
"id": "websecurityscanner.projects.scanConfigs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\nThe resource name of the ScanConfig to be deleted. The name follows the\nformat of 'projects/{projectId}/scanConfigs/{scanConfigId}'.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a ScanConfig.",
"flatPath": "v1beta/projects/{projectsId}/scanConfigs/{scanConfigsId}",
"httpMethod": "GET",
"id": "websecurityscanner.projects.scanConfigs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\nThe resource name of the ScanConfig to be returned. The name follows the\nformat of 'projects/{projectId}/scanConfigs/{scanConfigId}'.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "ScanConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists ScanConfigs under a given project.",
"flatPath": "v1beta/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.\nIf not specified or not positive, the implementation will select a\nreasonable value.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required.\nThe parent resource name, which should be a project resource name in the\nformat 'projects/{projectId}'.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+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": "v1beta/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\n'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are\ngenerated by the system.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required.\nThe update mask applies to the resource. For the `FieldMask` definition,\nsee\nhttps://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+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": "v1beta/projects/{projectsId}/scanConfigs/{scanConfigsId}:start",
"httpMethod": "POST",
"id": "websecurityscanner.projects.scanConfigs.start",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\nThe resource name of the ScanConfig to be used. The name follows the\nformat of 'projects/{projectId}/scanConfigs/{scanConfigId}'.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+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": "v1beta/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}",
"httpMethod": "GET",
"id": "websecurityscanner.projects.scanConfigs.scanRuns.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\nThe resource name of the ScanRun to be returned. The name follows the\nformat of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+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\nstop time.",
"flatPath": "v1beta/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.\nIf not specified or not positive, the implementation will select a\nreasonable value.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required.\nThe parent resource name, which should be a scan resource name in the\nformat 'projects/{projectId}/scanConfigs/{scanConfigId}'.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/scanRuns",
"response": {
"$ref": "ListScanRunsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"stop": {
"description": "Stops a ScanRun. The stopped ScanRun is returned.",
"flatPath": "v1beta/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}:stop",
"httpMethod": "POST",
"id": "websecurityscanner.projects.scanConfigs.scanRuns.stop",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\nThe resource name of the ScanRun to be stopped. The name follows the\nformat of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+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": "v1beta/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.\nIf not specified or not positive, the implementation will select a\nreasonable value.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required.\nThe parent resource name, which should be a scan run resource name in the\nformat\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+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": "v1beta/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats",
"httpMethod": "GET",
"id": "websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required.\nThe parent resource name, which should be a scan run resource name in the\nformat\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/findingTypeStats",
"response": {
"$ref": "ListFindingTypeStatsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"findings": {
"methods": {
"get": {
"description": "Gets a Finding.",
"flatPath": "v1beta/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings/{findingsId}",
"httpMethod": "GET",
"id": "websecurityscanner.projects.scanConfigs.scanRuns.findings.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\nThe resource name of the Finding to be returned. The name follows the\nformat of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+/findings/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Finding"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List Findings under a given ScanRun.",
"flatPath": "v1beta/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings",
"httpMethod": "GET",
"id": "websecurityscanner.projects.scanConfigs.scanRuns.findings.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter expression. The expression must be in the format: \u003cfield\u003e\n\u003coperator\u003e \u003cvalue\u003e.\nSupported field: 'finding_type'.\nSupported operator: '='.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of Findings to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required.\nThe parent resource name, which should be a scan run resource name in the\nformat\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/findings",
"response": {
"$ref": "ListFindingsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
}
}
},
"revision": "20190323",
"rootUrl": "https://websecurityscanner.googleapis.com/",
"schemas": {
"Authentication": {
"description": "Scan authentication configuration.",
"id": "Authentication",
"properties": {
"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\nSecurity Scanner Service crawls the web applications, following all links\nwithin the scope of sites, to find the URLs to test against.",
"id": "CrawledUrl",
"properties": {
"body": {
"description": "Output only.\nThe body of the request that was used to visit the URL.",
"type": "string"
},
"httpMethod": {
"description": "Output only.\nThe http method of the request that was used to visit the URL, in\nuppercase.",
"type": "string"
},
"url": {
"description": "Output only.\nThe URL that was crawled.",
"type": "string"
}
},
"type": "object"
},
"CustomAccount": {
"description": "Describes authentication configuration that uses a custom account.",
"id": "CustomAccount",
"properties": {
"loginUrl": {
"description": "Required.\nThe login form URL of the website.",
"type": "string"
},
"password": {
"description": "Input only.\nRequired.\nThe password of the custom account. The credential is stored encrypted\nand not returned in any response nor included in audit logs.",
"type": "string"
},
"username": {
"description": "Required.\nThe 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\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe 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\nScanRun.",
"id": "Finding",
"properties": {
"body": {
"description": "Output only.\nThe body of the request that triggered the vulnerability.",
"type": "string"
},
"description": {
"description": "Output only.\nThe description of the vulnerability.",
"type": "string"
},
"finalUrl": {
"description": "Output only.\nThe URL where the browser lands when the vulnerability is detected.",
"type": "string"
},
"findingType": {
"description": "Output only.\nThe type of the Finding.\nDetailed and up-to-date information on findings can be found here:\nhttps://cloud.google.com/security-scanner/docs/scan-result-details",
"type": "string"
},
"form": {
"$ref": "Form",
"description": "Output only.\nAn addon containing information reported for a vulnerability with an HTML\nform, if any."
},
"frameUrl": {
"description": "Output only.\nIf the vulnerability was originated from nested IFrame, the immediate\nparent IFrame is reported.",
"type": "string"
},
"fuzzedUrl": {
"description": "Output only.\nThe URL produced by the server-side fuzzer and used in the request that\ntriggered the vulnerability.",
"type": "string"
},
"httpMethod": {
"description": "Output only.\nThe http method of the request that triggered the vulnerability, in\nuppercase.",
"type": "string"
},
"name": {
"description": "Output only.\nThe resource name of the Finding. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'.\nThe finding IDs are generated by the system.",
"type": "string"
},
"outdatedLibrary": {
"$ref": "OutdatedLibrary",
"description": "Output only.\nAn addon containing information about outdated libraries."
},
"reproductionUrl": {
"description": "Output only.\nThe URL containing human-readable payload that user can leverage to\nreproduce the vulnerability.",
"type": "string"
},
"trackingId": {
"description": "Output only.\nThe tracking ID uniquely identifies a vulnerability instance across\nmultiple ScanRuns.",
"type": "string"
},
"violatingResource": {
"$ref": "ViolatingResource",
"description": "Output only.\nAn addon containing detailed information regarding any resource causing the\nvulnerability such as JavaScript sources, image, audio files, etc."
},
"vulnerableHeaders": {
"$ref": "VulnerableHeaders",
"description": "Output only.\nAn addon containing information about vulnerable or missing HTTP headers."
},
"vulnerableParameters": {
"$ref": "VulnerableParameters",
"description": "Output only.\nAn addon containing information about request parameters which were found\nto be vulnerable."
},
"xss": {
"$ref": "Xss",
"description": "Output only.\nAn addon containing information reported for an XSS, if any."
}
},
"type": "object"
},
"FindingTypeStats": {
"description": "A FindingTypeStats resource represents stats regarding a specific FindingType\nof Findings under a given ScanRun.",
"id": "FindingTypeStats",
"properties": {
"findingCount": {
"description": "Output only.\nThe count of findings belonging to this finding type.",
"format": "int32",
"type": "integer"
},
"findingType": {
"description": "Output only.\nThe finding type associated with the stats.",
"type": "string"
}
},
"type": "object"
},
"Form": {
"description": "! Information about a vulnerability with an HTML.",
"id": "Form",
"properties": {
"actionUri": {
"description": "! The URI where to send the form when it's submitted.",
"type": "string"
},
"fields": {
"description": "! The names of form fields related to the vulnerability.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleAccount": {
"description": "Describes authentication configuration that uses a Google account.",
"id": "GoogleAccount",
"properties": {
"password": {
"description": "Input only.\nRequired.\nThe password of the Google account. The credential is stored encrypted\nand not returned in any response nor included in audit logs.",
"type": "string"
},
"username": {
"description": "Required.\nThe user name of the Google account.",
"type": "string"
}
},
"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\nmore results in the list.",
"type": "string"
}
},
"type": "object"
},
"ListFindingTypeStatsResponse": {
"description": "Response for the `ListFindingTypeStats` method.",
"id": "ListFindingTypeStatsResponse",
"properties": {
"findingTypeStats": {
"description": "The list of FindingTypeStats returned.",
"items": {
"$ref": "FindingTypeStats"
},
"type": "array"
}
},
"type": "object"
},
"ListFindingsResponse": {
"description": "Response for the `ListFindings` method.",
"id": "ListFindingsResponse",
"properties": {
"findings": {
"description": "The list of Findings returned.",
"items": {
"$ref": "Finding"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
}
},
"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\nmore 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\nmore 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.\nnext id: 12",
"id": "ScanConfig",
"properties": {
"authentication": {
"$ref": "Authentication",
"description": "The authentication configuration. If specified, service will use the\nauthentication configuration during scanning."
},
"blacklistPatterns": {
"description": "The blacklist URL patterns as described in\nhttps://cloud.google.com/security-scanner/docs/excluded-urls",
"items": {
"type": "string"
},
"type": "array"
},
"displayName": {
"description": "Required.\nThe user provided display name of the ScanConfig.",
"type": "string"
},
"exportToSecurityCommandCenter": {
"description": "Controls export of scan configurations and results to Cloud Security\nCommand Center.",
"enum": [
"EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED",
"ENABLED",
"DISABLED"
],
"enumDescriptions": [
"Use default, which is ENABLED.",
"Export results of this scan to Cloud Security Command Center.",
"Do not export results of this scan to Cloud Security Command Center."
],
"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\ninclusively. If the field is unspecified or its value is set 0, server will\ndefault to 15. Other values outside of [5, 20] range will be rejected with\nINVALID_ARGUMENT error.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "The resource name of the ScanConfig. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are\ngenerated by the system.",
"type": "string"
},
"schedule": {
"$ref": "Schedule",
"description": "The schedule of the ScanConfig."
},
"startingUrls": {
"description": "Required.\nThe starting URLs from which the scanner finds site pages.",
"items": {
"type": "string"
},
"type": "array"
},
"targetPlatforms": {
"description": "Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be\nused as a default.",
"enumDescriptions": [
"The target platform is unknown. Requests with this enum value will be\nrejected with INVALID_ARGUMENT error.",
"Google App Engine service.",
"Google Compute Engine service."
],
"items": {
"enum": [
"TARGET_PLATFORM_UNSPECIFIED",
"APP_ENGINE",
"COMPUTE"
],
"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"
},
"ScanConfigError": {
"description": "Defines a custom error message used by CreateScanConfig and UpdateScanConfig\nAPIs when scan configuration validation fails. It is also reported as part of\na ScanRunErrorTrace message if scan validation fails due to a scan\nconfiguration error.",
"id": "ScanConfigError",
"properties": {
"code": {
"description": "Output only.\nIndicates the reason code for a configuration failure.",
"enum": [
"CODE_UNSPECIFIED",
"OK",
"INTERNAL_ERROR",
"APPENGINE_API_BACKEND_ERROR",
"APPENGINE_API_NOT_ACCESSIBLE",
"APPENGINE_DEFAULT_HOST_MISSING",
"APPENGINE_SEED_URL_NOT_ALLOWED",
"CANNOT_USE_GOOGLE_COM_ACCOUNT",
"CANNOT_USE_OWNER_ACCOUNT",
"COMPUTE_API_BACKEND_ERROR",
"COMPUTE_API_NOT_ACCESSIBLE",
"CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT",
"CUSTOM_LOGIN_URL_MALFORMED",
"CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS",
"CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS",
"CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS",
"CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS",
"DUPLICATE_SCAN_NAME",
"INVALID_FIELD_VALUE",
"FAILED_TO_AUTHENTICATE_TO_TARGET",
"FINDING_TYPE_UNSPECIFIED",
"FORBIDDEN_TO_SCAN_COMPUTE",
"MALFORMED_FILTER",
"MALFORMED_RESOURCE_NAME",
"PROJECT_INACTIVE",
"REQUIRED_FIELD",
"RESOURCE_NAME_INCONSISTENT",
"SCAN_ALREADY_RUNNING",
"SCAN_NOT_RUNNING",
"SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT",
"SEED_URL_MALFORMED",
"SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS",
"SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS",
"SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS",
"SEED_URL_IP_ADDRESS_NOT_SUPPORTED_FOR_APPENGINE",
"SEED_URL_HAS_UNRESERVED_IP_ADDRESS",
"SERVICE_ACCOUNT_NOT_CONFIGURED",
"TOO_MANY_SCANS",
"UNABLE_TO_RESOLVE_PROJECT_INFO",
"UNSUPPORTED_BLACKLIST_PATTERN_FORMAT",
"UNSUPPORTED_FILTER",
"UNSUPPORTED_FINDING_TYPE",
"UNSUPPORTED_URL_SCHEME"
],
"enumDescriptions": [
"There is no error.",
"There is no error.",
"Indicates an internal server error.\nPlease DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.",
"One of the seed URLs is an App Engine URL but we cannot validate the scan\nsettings due to an App Engine API backend error.",
"One of the seed URLs is an App Engine URL but we cannot access the\nApp Engine API to validate scan settings.",
"One of the seed URLs is an App Engine URL but the Default Host of the\nApp Engine is not set.",
"One of the seed URLs is an App Engine URL and the scan targets\nCompute Engine only.",
"Google corporate accounts can not be used for scanning.",
"The account of the scan creator can not be used for scanning.",
"This scan targets Compute Engine, but we cannot validate scan settings\ndue to a Compute Engine API backend error.",
"This scan targets Compute Engine, but we cannot access the Compute Engine\nAPI to validate the scan settings.",
"The Custom Login URL does not belong to the current project.",
"The Custom Login URL is malformed (can not be parsed).",
"The Custom Login URL is mapped to a non-routable IP address in DNS.",
"The Custom Login URL is mapped to an IP address which is not reserved for\nthe current project.",
"The Custom Login URL has a non-routable IP address.",
"The Custom Login URL has an IP address which is not reserved for the\ncurrent project.",
"Another scan with the same name (case-sensitive) already exists.",
"A field is set to an invalid value.",
"There was an error trying to authenticate to the scan target.",
"Finding type value is not specified in the list findings request.",
"Scan targets Compute Engine, yet current project was not whitelisted for\nGoogle Compute Engine Scanning Alpha access.",
"The supplied filter is malformed. For example, it can not be parsed, does\nnot have a filter type in expression, or the same filter type appears\nmore than once.",
"The supplied resource name is malformed (can not be parsed).",
"The current project is not in an active state.",
"A required field is not set.",
"Project id, scanconfig id, scanrun id, or finding id are not consistent\nwith each other in resource name.",
"The scan being requested to start is already running.",
"The scan that was requested to be stopped is not running.",
"One of the seed URLs does not belong to the current project.",
"One of the seed URLs is malformed (can not be parsed).",
"One of the seed URLs is mapped to a non-routable IP address in DNS.",
"One of the seed URLs is mapped to an IP address which is not reserved\nfor the current project.",
"One of the seed URLs has on-routable IP address.",
"One of the supplied seed URLs has an IP address, and this is not\nsupported in App Engine-only targeted scan.",
"One of the seed URLs has an IP address that is not reserved\nfor the current project.",
"The Cloud Security Scanner service account is not configured under the\nproject.",
"A project has reached the maximum number of scans.",
"Resolving the details of the current project fails.",
"One or more blacklist patterns were in the wrong format.",
"The supplied filter is not supported.",
"The supplied finding type is not supported. For example, we do not\nprovide findings of the given finding type.",
"The URL scheme of one or more of the supplied URLs is not supported."
],
"type": "string"
},
"fieldName": {
"description": "Output only.\nIndicates the full name of the ScanConfig field that triggers this error,\nfor example \"scan_config.max_qps\". This field is provided for\ntroubleshooting purposes only and its actual value can change in the\nfuture.",
"type": "string"
}
},
"type": "object"
},
"ScanRun": {
"description": "A ScanRun is a output-only resource representing an actual run of the scan.\nNext id: 12",
"id": "ScanRun",
"properties": {
"endTime": {
"description": "Output only.\nThe time at which the ScanRun reached termination state - that the ScanRun\nis either finished or stopped by user.",
"format": "google-datetime",
"type": "string"
},
"errorTrace": {
"$ref": "ScanRunErrorTrace",
"description": "Output only.\nIf result_state is an ERROR, this field provides the primary reason for\nscan's termination and more details, if such are available."
},
"executionState": {
"description": "Output only.\nThe execution state of the ScanRun.",
"enum": [
"EXECUTION_STATE_UNSPECIFIED",
"QUEUED",
"SCANNING",
"FINISHED"
],
"enumDescriptions": [
"Represents an invalid state caused by internal server error. This value\nshould 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": "Output only.\nWhether the scan run has found any vulnerabilities.",
"type": "boolean"
},
"name": {
"description": "Output only.\nThe resource name of the ScanRun. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.\nThe ScanRun IDs are generated by the system.",
"type": "string"
},
"progressPercent": {
"description": "Output only.\nThe percentage of total completion ranging from 0 to 100.\nIf the scan is in queue, the value is 0.\nIf the scan is running, the value ranges from 0 to 100.\nIf the scan is finished, the value is 100.",
"format": "int32",
"type": "integer"
},
"resultState": {
"description": "Output only.\nThe result state of the ScanRun. This field is only available after the\nexecution state reaches \"FINISHED\".",
"enum": [
"RESULT_STATE_UNSPECIFIED",
"SUCCESS",
"ERROR",
"KILLED"
],
"enumDescriptions": [
"Default value. This value is returned when the ScanRun is not yet\nfinished.",
"The scan finished without errors.",
"The scan finished with errors.",
"The scan was terminated by user."
],
"type": "string"
},
"startTime": {
"description": "Output only.\nThe time at which the ScanRun started.",
"format": "google-datetime",
"type": "string"
},
"urlsCrawledCount": {
"description": "Output only.\nThe number of URLs crawled during this ScanRun. If the scan is in progress,\nthe value represents the number of URLs crawled up to now.",
"format": "int64",
"type": "string"
},
"urlsTestedCount": {
"description": "Output only.\nThe number of URLs tested during this ScanRun. If the scan is in progress,\nthe value represents the number of URLs tested up to now. The number of\nURLs tested is usually larger than the number URLS crawled because\ntypically a crawled URL is tested with multiple test payloads.",
"format": "int64",
"type": "string"
},
"warningTraces": {
"description": "Output only.\nA list of warnings, if such are encountered during this scan run.",
"items": {
"$ref": "ScanRunWarningTrace"
},
"type": "array"
}
},
"type": "object"
},
"ScanRunErrorTrace": {
"description": "Output only.\nDefines an error trace message for a ScanRun.",
"id": "ScanRunErrorTrace",
"properties": {
"code": {
"description": "Output only.\nIndicates the error reason code.",
"enum": [
"CODE_UNSPECIFIED",
"INTERNAL_ERROR",
"SCAN_CONFIG_ISSUE",
"AUTHENTICATION_CONFIG_ISSUE",
"TIMED_OUT_WHILE_SCANNING",
"TOO_MANY_REDIRECTS",
"TOO_MANY_HTTP_ERRORS"
],
"enumDescriptions": [
"Default value is never used.",
"Indicates that the scan run failed due to an internal server error.",
"Indicates a scan configuration error, usually due to outdated ScanConfig\nsettings, such as starting_urls or the DNS configuration.",
"Indicates an authentication error, usually due to outdated ScanConfig\nauthentication settings.",
"Indicates a scan operation timeout, usually caused by a very large site.",
"Indicates that a scan encountered excessive redirects, either to\nauthentication or some other page outside of the scan scope.",
"Indicates that a scan encountered numerous errors from the web site\npages. When available, most_common_http_error_code field indicates the\nthe most common HTTP error code encountered during the scan."
],
"type": "string"
},
"mostCommonHttpErrorCode": {
"description": "Output only.\nIf the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most\ncommon HTTP error code, if such is available. For example, if this code is\n404, the scan has encountered too many NOT_FOUND responses.",
"format": "int32",
"type": "integer"
},
"scanConfigError": {
"$ref": "ScanConfigError",
"description": "Output only.\nIf the scan encounters SCAN_CONFIG_ISSUE error, this field has the error\nmessage encountered during scan configuration validation that is performed\nbefore each scan run."
}
},
"type": "object"
},
"ScanRunWarningTrace": {
"description": "Output only.\nDefines a warning trace message for ScanRun. Warning traces provide customers\nwith useful information that helps make the scanning process more effective.",
"id": "ScanRunWarningTrace",
"properties": {
"code": {
"description": "Output only.\nIndicates the warning code.",
"enum": [
"CODE_UNSPECIFIED",
"INSUFFICIENT_CRAWL_RESULTS",
"TOO_MANY_CRAWL_RESULTS",
"TOO_MANY_FUZZ_TASKS",
"BLOCKED_BY_IAP"
],
"enumDescriptions": [
"Default value is never used.",
"Indicates that a scan discovered an unexpectedly low number of URLs. This\nis sometimes caused by complex navigation features or by using a single\nURL for numerous pages.",
"Indicates that a scan discovered too many URLs to test, or excessive\nredundant URLs.",
"Indicates that too many tests have been generated for the scan. Customer\nshould try reducing the number of starting URLs, increasing the QPS rate,\nor narrowing down the scope of the scan using the excluded patterns.",
"Indicates that a scan is blocked by IAP."
],
"type": "string"
}
},
"type": "object"
},
"Schedule": {
"description": "Scan schedule configuration.",
"id": "Schedule",
"properties": {
"intervalDurationDays": {
"description": "Required.\nThe 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\nrefreshed by the server after each run. If unspecified, it will default\nto current server time, which means the scan will be scheduled to start\nimmediately.",
"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\nas 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"
}
},
"servicePath": "",
"title": "Web Security Scanner API",
"version": "v1beta",
"version_module": true
}
Reference in a new issue Copy permalink