Method: projects.sources.locations.findings.group

Filtra as descobertas de uma organização ou fonte e as agrupa por propriedades especificadas em um local. Se nenhum local for especificado, as descobertas serão consideradas globais.

Para agrupar todas as fontes, forneça um - como o ID da fonte. Confira alguns exemplos na lista a seguir:

  • /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

Solicitação HTTP


Os URLs usam a sintaxe de Transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Nome da origem a ser usada como groupBy. Se nenhum local for especificado, a descoberta será considerada global. Confira alguns exemplos na lista a seguir:

  • 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]

Para agrupar por todas as fontes, forneça um source_id de -. Confira alguns exemplos na lista a seguir:

  • 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]

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "filter": string,
  "groupBy": string,
  "pageToken": string,
  "pageSize": integer
}
Campos
filter

string

Expressão que define o filtro a ser aplicado às descobertas. A expressão é uma lista de uma ou mais restrições combinadas pelos operadores lógicos AND e OR. Os parênteses são aceitos, e OR tem precedência maior que AND.

As restrições têm a forma <field> <operator> <value> e podem ter um caractere - na frente para indicar a negação. Por exemplo:

  • nome
  • securityMarks.marks.marka

Os operadores compatíveis são:

  • = para todos os tipos de valor.
  • >, <, >=, <= para valores inteiros.
  • :, que significa correspondência de substring, para strings.

Os tipos de valor aceitos são:

  • literais de string entre aspas.
  • literais inteiros sem aspas.
  • literais booleanos true e false sem aspas;

As seguintes combinações de campos e operadores são compatíveis:

  • nome: =
  • pai: =, :
  • resourceName: =, :
  • state: =, :
  • categoria: =, :
  • externalUri: =, :
  • eventTime: =, >, <, >=, <=

Uso: milissegundos desde a época ou uma string RFC3339. Exemplos: eventTime = "2019-06-10T16:07:18-07:00" eventTime = 1560208038000

  • gravidade: =, :
  • securityMarks.marks: =, :
  • resource:
  • resource.name: =, :
  • resource.parent_name: =, :
  • resource.parent_display_name: =, :
  • resource.project_name: =, :
  • resource.project_display_name: =, :
  • resource.type: =, :
groupBy

string

Obrigatório. Expressão que define quais campos de recursos usar para agrupamento. O valor da string precisa seguir a sintaxe SQL: lista de campos separada por vírgulas. Por exemplo: "parent,resourceName".
pageToken

string

O valor retornado pelo último GroupFindingsResponse indica que esta é uma continuação de uma chamada findings.group anterior e que o sistema precisa retornar a próxima página de dados.
pageSize

integer

O número máximo de resultados a serem retornados em uma única resposta. O padrão é 10, o mínimo é 1 e o máximo é 1.000.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de GroupFindingsResponse.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.