Method: organizations.sources.findings.group

Filtra as descobertas de uma organização ou fonte e as agrupa por propriedades especificadas.

Para agrupar todas as fontes, forneça um - como o ID da fonte. Exemplo: /v1beta1/organizations/{organization_id}/sources/-/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. O formato é "organizations/[organization_id]/sources/[source_id]". Para agrupar por todas as fontes, forneça um source_id de -. Por exemplo: organizations/{organization_id}/sources/-

Corpo da solicitação

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

Representação JSON 
{
  "filter": string,
  "groupBy": string,
  "readTime": 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. Não há suporte para parênteses, 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
  • sourceProperties.a_property
  • 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;

Por exemplo, sourceProperties.size = 100 é uma string de filtro válida.
groupBy

string

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

Os campos a seguir são compatíveis:

  • resourceName
  • categoria
  • estado
  • primária
readTime

string (Timestamp format)

Tempo usado como ponto de referência ao filtrar descobertas. O filtro é limitado às descobertas existentes no momento fornecido, e os valores são aqueles no momento específico. A ausência desse campo vai usar a versão da API do NOW.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
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

Mensagem de resposta para agrupar por descobertas.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "groupByResults": [
    {
      object (GroupResult)
    }
  ],
  "readTime": string,
  "nextPageToken": string
}
Campos
groupByResults[]

object (GroupResult)

Agrupar resultados. Há um elemento para cada combinação exclusiva de propriedade/valores. O elemento contém uma contagem do número de vezes que essas propriedades/valores específicos aparecem.
readTime

string (Timestamp format)

Tempo usado para executar a solicitação groupBy.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
nextPageToken

string

Token para recuperar a próxima página de resultados ou vazia se não houver mais resultados.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.