Method: organizations.sources.findings.list

Lists an organization or source's findings.

To list across all sources provide a - as the source id. Example: /v1beta1/organizations/{organization_id}/sources/-/findings

HTTP request


The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list across all sources provide a source_id of -. For example: organizations/{organization_id}/sources/-

Query parameters

Parameters
filter

string

Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators AND and OR. Parentheses are not supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. Examples include:

  • name
  • sourceProperties.a_property
  • securityMarks.marks.marka

The supported operators are:

  • = for all value types.
  • >, <, >=, <= for integer values.
  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.
  • integer literals without quotes.
  • boolean literals true and false without quotes.

For example, sourceProperties.size = 100 is a valid filter string.
orderBy

string

Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resourceProperties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,sourceProperties.a_property". Redundant space characters in the syntax are insignificant. "name desc,sourceProperties.a_property" and " name desc , sourceProperties.a_property " are equivalent.
readTime

string (Timestamp format)

Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
fieldMask

string (FieldMask format)

Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
pageToken

string

The value returned by the last ListFindingsResponse; indicates that this is a continuation of a prior findings.list call, and that the system should return the next page of data.
pageSize

integer

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

Request body

The request body must be empty.

Response body

Response message for listing findings.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "findings": [
    {
      object (Finding)
    }
  ],
  "readTime": string,
  "nextPageToken": string,
  "totalSize": integer
}
Fields
findings[]

object (Finding)

Findings matching the list request.
readTime

string (Timestamp format)

Time used for executing the list request.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
nextPageToken

string

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

integer

The total number of findings matching the query.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.