REST Resource: alerts

Ressource: Alert

Alerte affectant un client.

Représentation JSON 
{
  "customerId": string,
  "alertId": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "type": string,
  "source": string,
  "data": {
    "@type": string,
    field1: ...,
    ...
  },
  "securityInvestigationToolLink": string,
  "deleted": boolean,
  "metadata": {
    object (AlertMetadata)
  },
  "updateTime": string,
  "etag": string
}
Champs
customerId

string

Uniquement en sortie. Identifiant unique du compte Google Workspace du client.
alertId

string

Uniquement en sortie. Identifiant unique de l'alerte.
createTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle cette alerte a été créée.
startTime

string (Timestamp format)

Obligatoire. Heure à laquelle l'événement à l'origine de cette alerte a commencé ou a été détecté.
endTime

string (Timestamp format)

Facultatif. Heure à laquelle l'événement à l'origine de cette alerte a cessé d'être actif. Si elle est fournie, l'heure de fin ne doit pas être antérieure à l'heure de début. S'il n'est pas fourni, il indique qu'une alerte est en cours.
type

string

Obligatoire. Type de l'alerte. Cette sortie n'est générée qu'après la création de l'alerte. Pour obtenir la liste des types d'alertes disponibles, consultez Types d'alertes Google Workspace.
source

string

Obligatoire. Identifiant unique du système ayant généré l'alerte. Cette sortie n'est générée qu'après la création de l'alerte.

Les sources acceptées sont les suivantes:

  • Opérations Google
  • Gestion des appareils mobiles
  • Hameçonnage dans Gmail
  • Protection contre la perte de données
  • Récupération des données à l'échelle du domaine
  • Attaque soutenue par un État
  • Identité Google
  • Indisponibilité des applications
data

object

Facultatif. Données associées à cette alerte (par exemple, google.apps.alertcenter.type.DeviceCompromised).
deleted

boolean

Uniquement en sortie. True si cette alerte est marquée pour suppression.
metadata

object (AlertMetadata)

Uniquement en sortie. Métadonnées associées à cette alerte.
updateTime

string (Timestamp format)

Uniquement en sortie. Heure de la dernière mise à jour de cette alerte.
etag

string

Facultatif. etag permet d'effectuer un contrôle de simultanéité positive, pour éviter que les mises à jour simultanées d'une alerte ne s'écrasent les unes les autres. Nous vous recommandons vivement d'utiliser etag dans le cycle de lecture-modification-écriture pour effectuer des mises à jour d'alertes afin d'éviter les conditions de concurrence: un etag est renvoyé dans la réponse contenant les alertes, et les systèmes doivent placer cet etag dans la requête de mise à jour de l'alerte pour s'assurer que leur modification sera appliquée à la même version de l'alerte.

Si aucun etag n'est fourni dans l'appel de mise à jour de l'alerte, l'alerte existante est écrasée de manière aveugle.

AlertMetadata

Métadonnées d'une alerte.

Représentation JSON 
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
Champs
customerId

string

Uniquement en sortie. Identifiant unique du compte Google Workspace du client.
alertId

string

Uniquement en sortie. Identifiant de l'alerte.
status

string

État actuel de l'alerte. Les valeurs acceptées sont les suivantes:

  • NOT_STARTED
  • IN_PROGRESS (EN_COURS)
  • FERMÉ
assignee

string

Adresse e-mail de l'utilisateur affecté à l'alerte.
updateTime

string (Timestamp format)

Uniquement en sortie. Heure de la dernière mise à jour de ces métadonnées.
severity

string

Valeur de gravité de l'alerte. Le Centre d'alertes définit ce champ au moment de la création de l'alerte. Par défaut, il s'agit d'une chaîne vide si cette valeur n'a pas pu être déterminée. Les valeurs acceptées pour les actions de mise à jour de ce champ sont les suivantes:

  • ÉLEVÉ
  • MEDIUM (MOYEN)
  • FAIBLE
etag

string

Facultatif. etag permet d'effectuer un contrôle de simultanéité positive, pour éviter que les mises à jour simultanées des métadonnées d'une alerte ne s'écrasent les unes les autres. Nous vous recommandons vivement d'utiliser etag dans le cycle de lecture-modification-écriture pour effectuer des mises à jour de métadonnées afin d'éviter les conditions de concurrence: un etag est renvoyé dans la réponse contenant les métadonnées d'alerte, et les systèmes doivent placer cet etag dans la requête pour mettre à jour les métadonnées d'alerte afin de s'assurer que leur modification sera appliquée à la même version des métadonnées d'alerte.

Si aucun etag n'est fourni dans l'appel de mise à jour des métadonnées d'alerte, les métadonnées d'alerte existantes sont écrasées de manière aveugle.

Méthodes

batchDelete

 Effectue une suppression groupée des alertes.

batchUndelete

 Effectue une opération d'annulation de la suppression groupée sur les alertes.

delete

 Marque l'alerte spécifiée pour suppression.

get

 Récupère l'alerte spécifiée.

getMetadata

 Renvoie les métadonnées d'une alerte.

list

 Liste les alertes.

undelete

 Restaure (ou "annule la suppression") une alerte marquée pour suppression au cours des 30 derniers jours.