Filters an organization or source's findings and groups them by their specified properties in a location. If no location is specified, findings are assumed to be in global
To group across all sources provide a -
as the source id. The following list shows some examples:
/v2/organizations/{organization_id}/sources/-/findings
+/v2/organizations/{organization_id}/sources/-/locations/{locationId}/findings
/v2/folders/{folder_id}/sources/-/findings
/v2/folders/{folder_id}/sources/-/locations/{locationId}/findings
/v2/projects/{projectId}/sources/-/findings
/v2/projects/{projectId}/sources/-/locations/{locationId}/findings
HTTP request
The URLs use gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. Name of the source to groupBy. If no location is specified, finding is assumed to be in global. The following list shows some examples:
To groupBy across all sources provide a source_id of
|
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "filter": string, "groupBy": string, "pageToken": string, "pageSize": integer } |
Fields | |
---|---|
filter |
Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators Restrictions have the form
The supported operators are:
The supported value types are:
The following field and operator combinations are supported:
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
|
groupBy |
Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resourceName". |
pageToken |
The value returned by the last |
pageSize |
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. |
Response body
If successful, the response body contains an instance of GroupFindingsResponse
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.