Module types (0.3.0)

API documentation for websecurityscanner_v1alpha.types module.

Classes

CrawledUrl

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.

Output only. The URL that was crawled.

CreateScanConfigRequest

Request for the CreateScanConfig method.

Required. The ScanConfig to be created.

DeleteScanConfigRequest

Request for the DeleteScanConfig method.

Empty

API documentation for websecurityscanner_v1alpha.types.Empty class.

FieldMask

API documentation for websecurityscanner_v1alpha.types.FieldMask class.

Finding

A Finding resource represents a vulnerability instance identified during a ScanRun.

Output only. The type of the Finding.

Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.

Output only. The description of the vulnerability.

Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.

Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.

Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

Output only. An addon containing information reported for an XSS, if any.

FindingTypeStats

A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.

Output only. The count of findings belonging to this finding type.

GetFindingRequest

Request for the GetFinding method.

GetScanConfigRequest

Request for the GetScanConfig method.

GetScanRunRequest

Request for the GetScanRun method.

ListCrawledUrlsRequest

Request for the ListCrawledUrls method.

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.

ListCrawledUrlsResponse

Response for the ListCrawledUrls method.

Token to retrieve the next page of results, or empty if there are no more results in the list.

ListFindingTypeStatsRequest

Request for the ListFindingTypeStats method.

ListFindingTypeStatsResponse

Response for the ListFindingTypeStats method.

ListFindingsRequest

Request for the ListFindings method.

The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.

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.

ListFindingsResponse

Response for the ListFindings method.

Token to retrieve the next page of results, or empty if there are no more results in the list.

ListScanConfigsRequest

Request for the ListScanConfigs method.

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.

ListScanConfigsResponse

Response for the ListScanConfigs method.

Token to retrieve the next page of results, or empty if there are no more results in the list.

ListScanRunsRequest

Request for the ListScanRuns method.

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.

ListScanRunsResponse

Response for the ListScanRuns method.

Token to retrieve the next page of results, or empty if there are no more results in the list.

OutdatedLibrary

Information reported for an outdated library.

The version number.

ScanConfig

A ScanConfig resource contains the configurations to launch a scan.

Required. The user provided display name of the ScanConfig.

Required. The starting URLs from which the scanner finds site pages.

The user agent used during scanning.

The schedule of the ScanConfig.

ScanRun

A ScanRun is a output-only resource representing an actual run of the scan.

Output only. The execution state of the ScanRun.

Output only. The time at which the ScanRun started.

Output only. 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.

Output only. Whether the scan run has found any vulnerabilities.

StartScanRunRequest

Request for the StartScanRun method.

StopScanRunRequest

Request for the StopScanRun method.

Timestamp

API documentation for websecurityscanner_v1alpha.types.Timestamp class.

UpdateScanConfigRequest

Request for the UpdateScanConfigRequest method.

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#fieldmask

ViolatingResource

Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

URL of this violating resource.

VulnerableParameters

Information about vulnerable request parameters.

Xss

Information reported for an XSS.

An error message generated by a javascript breakage.