Method: folders.sources.findings.group

Filtra los hallazgos de una organización o fuente y los agrupa según sus propiedades especificadas en una ubicación. Si no se especifica una ubicación, se supone que los resultados son globales.

Para agrupar todas las fuentes, proporciona un - como el ID de fuente. En la siguiente lista, se muestran algunos ejemplos:

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

Solicitud HTTP


Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre de la fuente para groupBy. Si no se especifica una ubicación, se supone que el hallazgo es global. En la siguiente lista, se muestran algunos ejemplos:

  • 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 en todas las fuentes, proporciona un source_id de -. En la siguiente lista, se muestran algunos ejemplos:

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

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "filter": string,
  "groupBy": string,
  "pageToken": string,
  "pageSize": integer
}
Campos
filter

string

Es una expresión que define el filtro que se aplicará a todos los resultados. La expresión es una lista de una o más restricciones combinadas a través de los operadores lógicos AND y OR. Se admiten paréntesis, y OR tiene una prioridad más alta que AND.

Las restricciones tienen el formato <field> <operator> <value> y pueden tener un carácter - delante para indicar la negación. Los ejemplos incluyen:

  • nombre
  • securityMarks.marks.marka

Los operadores admitidos son los siguientes:

  • = para todos los tipos de valores.
  • >, <, >=, <= para valores enteros
  • :, que significa coincidencia de substring, para cadenas.

Los tipos de valores admitidos son los siguientes:

  • literales de cadena entre comillas.
  • literales de número entero sin comillas.
  • Literales booleanos true y false sin comillas.

Se admiten las siguientes combinaciones de campos y operadores:

  • nombre: =
  • superior: =, :
  • resourceName: =, :
  • estado: =, :
  • categoría: =, :
  • externalUri: =, :
  • eventTime: =, >, <, >=, <=

Uso: Debe ser una cadena RFC3339 o milisegundos desde la época. Ejemplos: eventTime = "2019-06-10T16:07:18-07:00" eventTime = 1560208038000

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

string

Obligatorio. Es una expresión que define qué campos de recursos se deben usar para el agrupamiento. El valor de cadena debe seguir la sintaxis de SQL: lista de campos separados por comas. Por ejemplo: "parent,resourceName".
pageToken

string

El valor que muestra el último GroupFindingsResponse indica que esta es una continuación de una llamada findings.group anterior y que el sistema debe mostrar la siguiente página de datos.
pageSize

integer

Es la cantidad máxima de resultados que se mostrarán en una sola respuesta. El valor predeterminado es 10, el mínimo es 1 y el máximo es 1, 000.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de GroupFindingsResponse.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Authentication Overview.