Skip to main content

findings

Creates, updates, deletes, gets or lists a findings resource.

Overview

Namefindings
TypeResource
Idgoogle.securitycenter.findings

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
findingobjectFinding matching the search request. (id: Finding)
resourceobjectOutput only. Resource that is associated with this finding. (id: Resource)
stateChangestringState change of the finding between the points in time.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
folders_sources_findings_listselectfoldersId, sourcesIdfilter, orderBy, readTime, compareDuration, fieldMask, pageToken, pageSizeLists an organization or source's findings. To list across all sources provide a - as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings
projects_sources_findings_listselectprojectsId, sourcesIdfilter, orderBy, readTime, compareDuration, fieldMask, pageToken, pageSizeLists an organization or source's findings. To list across all sources provide a - as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings
organizations_sources_findings_listselectorganizationsId, sourcesIdfilter, orderBy, readTime, compareDuration, fieldMask, pageToken, pageSizeLists an organization or source's findings. To list across all sources provide a - as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings
organizations_sources_findings_createinsertorganizationsId, sourcesIdfindingIdCreates a finding. The corresponding source must exist for finding creation to succeed.
folders_sources_findings_patchupdatefoldersId, sourcesId, findingsIdupdateMaskCreates or updates a finding. The corresponding source must exist for a finding creation to succeed.
projects_sources_findings_patchupdateprojectsId, sourcesId, findingsIdupdateMaskCreates or updates a finding. The corresponding source must exist for a finding creation to succeed.
organizations_sources_findings_patchupdateorganizationsId, sourcesId, findingsIdupdateMaskCreates or updates a finding. The corresponding source must exist for a finding creation to succeed.
folders_findings_bulk_muteexecfoldersIdKicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.
folders_sources_findings_groupexecfoldersId, sourcesIdFilters an organization or source's findings and groups them by their specified properties. To group across all sources provide a - as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings
folders_sources_findings_set_stateexecfoldersId, sourcesId, findingsIdUpdates the state of a finding.
folders_sources_findings_set_muteexecfoldersId, sourcesId, findingsIdUpdates the mute state of a finding.
projects_findings_bulk_muteexecprojectsIdKicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.
projects_sources_findings_groupexecprojectsId, sourcesIdFilters an organization or source's findings and groups them by their specified properties. To group across all sources provide a - as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings
projects_sources_findings_set_stateexecprojectsId, sourcesId, findingsIdUpdates the state of a finding.
projects_sources_findings_set_muteexecprojectsId, sourcesId, findingsIdUpdates the mute state of a finding.
organizations_findings_bulk_muteexecorganizationsIdKicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.
organizations_sources_findings_groupexecorganizationsId, sourcesIdFilters an organization or source's findings and groups them by their specified properties. To group across all sources provide a - as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings
organizations_sources_findings_set_stateexecorganizationsId, sourcesId, findingsIdUpdates the state of a finding.
organizations_sources_findings_set_muteexecorganizationsId, sourcesId, findingsIdUpdates the mute state of a finding.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
findingsIdstring
foldersIdstring
organizationsIdstring
projectsIdstring
sourcesIdstring
compareDurationstring (google-duration)
fieldMaskstring (google-fieldmask)
filterstring
findingIdstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
readTimestring (google-datetime)
updateMaskstring (google-fieldmask)

SELECT examples

Lists an organization or source's findings. To list across all sources provide a - as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings

SELECT
finding,
resource,
stateChange
FROM google.securitycenter.findings
WHERE foldersId = '{{ foldersId }}' -- required
AND sourcesId = '{{ sourcesId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND readTime = '{{ readTime }}'
AND compareDuration = '{{ compareDuration }}'
AND fieldMask = '{{ fieldMask }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

INSERT examples

Creates a finding. The corresponding source must exist for finding creation to succeed.

INSERT INTO google.securitycenter.findings (
data__name,
data__parent,
data__resourceName,
data__state,
data__category,
data__externalUri,
data__sourceProperties,
data__eventTime,
data__createTime,
data__severity,
data__canonicalName,
data__mute,
data__findingClass,
data__indicator,
data__vulnerability,
data__mitreAttack,
data__access,
data__connections,
data__muteInitiator,
data__processes,
data__compliances,
data__description,
data__exfiltration,
data__iamBindings,
data__nextSteps,
data__moduleName,
data__containers,
data__kubernetes,
data__database,
data__attackExposure,
data__files,
data__cloudDlpInspection,
data__cloudDlpDataProfile,
data__kernelRootkit,
data__orgPolicies,
data__job,
data__application,
data__ipRules,
data__backupDisasterRecovery,
data__securityPosture,
data__logEntries,
data__loadBalancers,
data__cloudArmor,
data__notebook,
data__toxicCombination,
data__groupMemberships,
data__disk,
data__dataAccessEvents,
data__dataFlowEvents,
data__networks,
data__dataRetentionDeletionEvents,
data__affectedResources,
data__aiModel,
data__chokepoint,
data__complianceDetails,
data__vertexAi,
organizationsId,
sourcesId,
findingId
)
SELECT
'{{ name }}',
'{{ parent }}',
'{{ resourceName }}',
'{{ state }}',
'{{ category }}',
'{{ externalUri }}',
'{{ sourceProperties }}',
'{{ eventTime }}',
'{{ createTime }}',
'{{ severity }}',
'{{ canonicalName }}',
'{{ mute }}',
'{{ findingClass }}',
'{{ indicator }}',
'{{ vulnerability }}',
'{{ mitreAttack }}',
'{{ access }}',
'{{ connections }}',
'{{ muteInitiator }}',
'{{ processes }}',
'{{ compliances }}',
'{{ description }}',
'{{ exfiltration }}',
'{{ iamBindings }}',
'{{ nextSteps }}',
'{{ moduleName }}',
'{{ containers }}',
'{{ kubernetes }}',
'{{ database }}',
'{{ attackExposure }}',
'{{ files }}',
'{{ cloudDlpInspection }}',
'{{ cloudDlpDataProfile }}',
'{{ kernelRootkit }}',
'{{ orgPolicies }}',
'{{ job }}',
'{{ application }}',
'{{ ipRules }}',
'{{ backupDisasterRecovery }}',
'{{ securityPosture }}',
'{{ logEntries }}',
'{{ loadBalancers }}',
'{{ cloudArmor }}',
'{{ notebook }}',
'{{ toxicCombination }}',
'{{ groupMemberships }}',
'{{ disk }}',
'{{ dataAccessEvents }}',
'{{ dataFlowEvents }}',
'{{ networks }}',
'{{ dataRetentionDeletionEvents }}',
'{{ affectedResources }}',
'{{ aiModel }}',
'{{ chokepoint }}',
'{{ complianceDetails }}',
'{{ vertexAi }}',
'{{ organizationsId }}',
'{{ sourcesId }}',
'{{ findingId }}'
RETURNING
name,
access,
affectedResources,
aiModel,
application,
attackExposure,
backupDisasterRecovery,
canonicalName,
category,
chokepoint,
cloudArmor,
cloudDlpDataProfile,
cloudDlpInspection,
complianceDetails,
compliances,
connections,
contacts,
containers,
createTime,
dataAccessEvents,
dataFlowEvents,
dataRetentionDeletionEvents,
database,
description,
disk,
eventTime,
exfiltration,
externalSystems,
externalUri,
files,
findingClass,
groupMemberships,
iamBindings,
indicator,
ipRules,
job,
kernelRootkit,
kubernetes,
loadBalancers,
logEntries,
mitreAttack,
moduleName,
mute,
muteInfo,
muteInitiator,
muteUpdateTime,
networks,
nextSteps,
notebook,
orgPolicies,
parent,
parentDisplayName,
processes,
resourceName,
securityMarks,
securityPosture,
severity,
sourceProperties,
state,
toxicCombination,
vertexAi,
vulnerability
;

UPDATE examples

Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.

UPDATE google.securitycenter.findings
SET
data__name = '{{ name }}',
data__parent = '{{ parent }}',
data__resourceName = '{{ resourceName }}',
data__state = '{{ state }}',
data__category = '{{ category }}',
data__externalUri = '{{ externalUri }}',
data__sourceProperties = '{{ sourceProperties }}',
data__eventTime = '{{ eventTime }}',
data__createTime = '{{ createTime }}',
data__severity = '{{ severity }}',
data__canonicalName = '{{ canonicalName }}',
data__mute = '{{ mute }}',
data__findingClass = '{{ findingClass }}',
data__indicator = '{{ indicator }}',
data__vulnerability = '{{ vulnerability }}',
data__mitreAttack = '{{ mitreAttack }}',
data__access = '{{ access }}',
data__connections = '{{ connections }}',
data__muteInitiator = '{{ muteInitiator }}',
data__processes = '{{ processes }}',
data__compliances = '{{ compliances }}',
data__description = '{{ description }}',
data__exfiltration = '{{ exfiltration }}',
data__iamBindings = '{{ iamBindings }}',
data__nextSteps = '{{ nextSteps }}',
data__moduleName = '{{ moduleName }}',
data__containers = '{{ containers }}',
data__kubernetes = '{{ kubernetes }}',
data__database = '{{ database }}',
data__attackExposure = '{{ attackExposure }}',
data__files = '{{ files }}',
data__cloudDlpInspection = '{{ cloudDlpInspection }}',
data__cloudDlpDataProfile = '{{ cloudDlpDataProfile }}',
data__kernelRootkit = '{{ kernelRootkit }}',
data__orgPolicies = '{{ orgPolicies }}',
data__job = '{{ job }}',
data__application = '{{ application }}',
data__ipRules = '{{ ipRules }}',
data__backupDisasterRecovery = '{{ backupDisasterRecovery }}',
data__securityPosture = '{{ securityPosture }}',
data__logEntries = '{{ logEntries }}',
data__loadBalancers = '{{ loadBalancers }}',
data__cloudArmor = '{{ cloudArmor }}',
data__notebook = '{{ notebook }}',
data__toxicCombination = '{{ toxicCombination }}',
data__groupMemberships = '{{ groupMemberships }}',
data__disk = '{{ disk }}',
data__dataAccessEvents = '{{ dataAccessEvents }}',
data__dataFlowEvents = '{{ dataFlowEvents }}',
data__networks = '{{ networks }}',
data__dataRetentionDeletionEvents = '{{ dataRetentionDeletionEvents }}',
data__affectedResources = '{{ affectedResources }}',
data__aiModel = '{{ aiModel }}',
data__chokepoint = '{{ chokepoint }}',
data__complianceDetails = '{{ complianceDetails }}',
data__vertexAi = '{{ vertexAi }}'
WHERE
foldersId = '{{ foldersId }}' --required
AND sourcesId = '{{ sourcesId }}' --required
AND findingsId = '{{ findingsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
access,
affectedResources,
aiModel,
application,
attackExposure,
backupDisasterRecovery,
canonicalName,
category,
chokepoint,
cloudArmor,
cloudDlpDataProfile,
cloudDlpInspection,
complianceDetails,
compliances,
connections,
contacts,
containers,
createTime,
dataAccessEvents,
dataFlowEvents,
dataRetentionDeletionEvents,
database,
description,
disk,
eventTime,
exfiltration,
externalSystems,
externalUri,
files,
findingClass,
groupMemberships,
iamBindings,
indicator,
ipRules,
job,
kernelRootkit,
kubernetes,
loadBalancers,
logEntries,
mitreAttack,
moduleName,
mute,
muteInfo,
muteInitiator,
muteUpdateTime,
networks,
nextSteps,
notebook,
orgPolicies,
parent,
parentDisplayName,
processes,
resourceName,
securityMarks,
securityPosture,
severity,
sourceProperties,
state,
toxicCombination,
vertexAi,
vulnerability;

Lifecycle Methods

Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.

EXEC google.securitycenter.findings.folders_findings_bulk_mute 
@foldersId='{{ foldersId }}' --required
@@json=
'{
"filter": "{{ filter }}",
"muteAnnotation": "{{ muteAnnotation }}",
"muteState": "{{ muteState }}"
}';