Method: organizations.sources.locations.findings.group

組織またはソースの検出結果をフィルタし、ロケーション内の指定されたプロパティでグループ化します。ロケーションが指定されていない場合、検出結果はグローバルにあると見なされます。

すべてのソースにまたがってグループ化するには、ソース ID として - を指定します。次のリストに例を示します。

  • /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 リクエスト


この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。groupBy のソースの名前。ロケーションが指定されていない場合、検出結果はグローバルであると見なされます。次のリストに例を示します。

  • organizations/[organization_id]/sources/[source_id] + organizations/[organization_id]/sources/[source_id]/locations/[locationId]
  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[locationId]
  • projects/[projectId]/sources/[source_id]
  • projects/[projectId]/sources/[source_id]/locations/[locationId]

すべてのソースでグループ化するには、source_id に - を指定します。次のリストに例を示します。

  • organizations/{organization_id}/sources/-
  • organizations/{organization_id}/sources/-/locations/[locationId]
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-/locations/[locationId]
  • projects/{projectId}/sources/-
  • projects/{projectId}/sources/-/locations/[locationId]

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "filter": string,
  "groupBy": string,
  "pageToken": string,
  "pageSize": integer
}
フィールド
filter

string

検出結果全体に適用するフィルタを定義する式。式は、論理演算子 ANDOR で結合された 1 つ以上の制限のリストです。かっこはサポートされています。ORAND よりも優先されます。

制限は <field> <operator> <value> の形式で、否定を示すために前に - 文字を付けることができます。次に例を示します。

  • name
  • securityMarks.marks.marka

サポートされている演算子は次のとおりです。

  • すべての値型で =
  • 整数値の場合は ><>=<=
  • :: 文字列の部分文字列照合。

サポートされている値の型は次のとおりです。

  • 文字列リテラルは引用符で囲みます。
  • 整数リテラル(引用符なし)。
  • ブール値リテラル truefalse(引用符なし)。

次のフィールドと演算子の組み合わせがサポートされています。

  • 名前: =
  • 親: =:
  • resourceName: =:
  • state: =:
  • カテゴリ: =:
  • externalUri: =:
  • eventTime: =><>=<=

使用方法: エポックからのミリ秒数または RFC3339 文字列にする必要があります。例: eventTime = "2019-06-10T16:07:18-07:00" eventTime = 1560208038000

  • 重大度: =:
  • securityMarks.marks: =:
  • resource:
  • resource.name: =:
  • resource.parent_name: =:
  • resource.parent_display_name: =:
  • resource.project_name: =:
  • resource.project_display_name: =:
  • resource.type: =:
groupBy

string

必須。グループ化に使用するアセット フィールドを定義する式。文字列の値は、SQL 構文に従って、フィールドのカンマ区切りリストにする必要があります。例: parent,resourceName。

pageToken

string

最後の GroupFindingsResponse で返された値は、これが前の findings.group 呼び出しの続きであり、システムからその次のページのデータが返される必要があることを示しています。

pageSize

integer

1 回のレスポンスで返される結果の最大件数。デフォルトは 10 で、最小値は 1、最大値は 1,000 です。

レスポンスの本文

成功した場合、レスポンスの本文には GroupFindingsResponse のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。