Method: organizations.sources.findings.setState

Updates the state of a finding.

HTTP request


The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The relative resource name of the finding. Example: organizations/{organization_id}/sources/{source_id}/findings/{findingId}, folders/{folder_id}/sources/{source_id}/findings/{findingId}, projects/{projectId}/sources/{source_id}/findings/{findingId}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "state": enum (State),
  "startTime": string
}
Fields
state

enum (State)

Required. The desired State of the finding.

startTime
(deprecated)

string (Timestamp format)

Optional. The time at which the updated state takes effect. If unset, defaults to the request time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Response body

If successful, the response body contains an instance of Finding.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.