Method: organizations.sources.findings.group

Filtre les résultats d'une organisation ou d'une source, et les regroupe en fonction de leurs propriétés spécifiées.

Pour regrouper toutes les sources, indiquez - comme ID de source. Exemple: /v1beta1/organizations/{organization_id}/sources/-/findings

Requête HTTP


Les URL utilisent la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la source à grouper. Il est au format "organizations/[organization_id]/sources/[source_id]". Pour grouper par source pour toutes les sources, spécifiez un identifiant de source de -. Par exemple: organizations/{organization_id}/sources/-

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "filter": string,
  "groupBy": string,
  "readTime": string,
  "pageToken": string,
  "pageSize": integer
}
Champs
filter

string

Expression qui définit le filtre à appliquer aux résultats. L'expression est une liste d'une ou plusieurs restrictions combinées à l'aide des opérateurs logiques AND et OR. Les parenthèses ne sont pas acceptées, et OR a une priorité plus élevée que AND.

Les restrictions ont la forme <field> <operator> <value> et peuvent être précédées d'un caractère - pour indiquer une négation. Voici quelques exemples :

  • nom
  • sourceProperties.a_property
  • securityMarks.marks.marka

Les opérateurs compatibles sont les suivants:

  • = pour tous les types de valeurs.
  • >, <, >=, <= pour les valeurs entières.
  • :, qui signifie "mise en correspondance de sous-chaîne", pour les chaînes.

Les types de valeurs acceptés sont les suivants:

  • littéraux de chaîne entre guillemets.
  • des littéraux entiers sans guillemets.
  • Les littéraux booléens true et false sans guillemets.

Par exemple, sourceProperties.size = 100 est une chaîne de filtre valide.
groupBy

string

Obligatoire. Expression qui définit les champs d'assets à utiliser pour le regroupement (y compris state). La valeur de chaîne doit respecter la syntaxe SQL: liste de champs séparés par une virgule. Par exemple: "parent,resourceName".

Les champs suivants sont acceptés:

  • resourceName
  • category
  • state
  • parent
readTime

string (Timestamp format)

Heure utilisée comme point de référence lors du filtrage des résultats. Le filtre est limité aux résultats existants au moment indiqué, et leurs valeurs correspondent à celles de ce moment précis. Si ce champ n'est pas spécifié, la version de l'API de NOW est utilisée par défaut.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
pageToken

string

La valeur renvoyée par le dernier GroupFindingsResponse indique qu'il s'agit de la continuation d'un appel findings.group précédent et que le système doit renvoyer la page de données suivante.
pageSize

integer

Nombre maximal de résultats à renvoyer dans une seule réponse. La valeur par défaut est 10. Elle doit être comprise entre 1 et 1 000 (inclus).

Corps de la réponse

Message de réponse pour regrouper les résultats.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "groupByResults": [
    {
      object (GroupResult)
    }
  ],
  "readTime": string,
  "nextPageToken": string
}
Champs
groupByResults[]

object (GroupResult)

Regrouper les résultats Un élément existe pour chaque combinaison unique de propriété/valeurs. L'élément contient le nombre d'occurrences de ces propriétés/valeurs spécifiques.
readTime

string (Timestamp format)

Temps utilisé pour exécuter la requête groupBy.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
nextPageToken

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez Authentication Overview.