Method: organizations.sources.findings.list

Lista as descobertas de uma organização ou fonte.

Para listar 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 das descobertas. O formato é "organizations/[organization_id]/sources/[source_id]". Para listar todas as origens, forneça um source_id de -. Por exemplo: organizations/{organization_id}/sources/-

Parâmetros de consulta

Parâmetros
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.

orderBy

string

Expressão que define quais campos e ordem usar para a classificação. O valor da string precisa seguir a sintaxe SQL: lista de campos separada por vírgulas. Por exemplo: "name,resourceProperties.a_property". A ordem de classificação padrão é crescente. Para especificar a ordem decrescente em um campo, um sufixo " desc" precisa ser anexado ao nome dele. Por exemplo: "name desc,sourceProperties.a_property". Caracteres de espaço redundantes na sintaxe são insignificantes. "name desc,sourceProperties.a_property" e "name desc , sourceProperties.a_property " são equivalentes.

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".

fieldMask

string (FieldMask format)

Opcional. Uma máscara de campo para especificar os campos de descoberta a serem listados na resposta. Uma máscara de campo vazia vai listar todos os campos.

pageToken

string

O valor retornado pelo último ListFindingsResponse indica que esta é uma continuação de uma chamada findings.list 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 solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para listar descobertas.

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

Representação JSON
{
  "findings": [
    {
      object (Finding)
    }
  ],
  "readTime": string,
  "nextPageToken": string,
  "totalSize": integer
}
Campos
findings[]

object (Finding)

Resultados que correspondem à solicitação de lista.

readTime

string (Timestamp format)

Tempo usado para executar a solicitação de lista.

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.

totalSize

integer

O número total de resultados que correspondem à consulta.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.