REST Resource: alerts

Ressource: Alerte

Alerte concernant 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 été démarré ou 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, cela indique une alerte en cours.

type

string

Obligatoire. Type d'alerte. Cette sortie n'est disponible qu'une fois l'alerte créée. Pour obtenir la liste des types d'alertes disponibles, consultez Types d'alertes Google Workspace.

source

string

Obligatoire. Identifiant unique du système ayant signalé l'alerte. Cette sortie n'est disponible qu'une fois l'alerte créée.

Les sources compatibles sont les suivantes:

  • Google Operations
  • Gestion des appareils mobiles
  • Hameçonnage dans Gmail
  • Data Loss Prevention
  • Récupération à l'échelle du domaine
  • Attaque commanditée par un État
  • Identité Google
  • Interruption 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 un contrôle de simultanéité optimiste pour éviter que les mises à jour simultanées d'une alerte ne s'écrasent les unes les autres. Il est fortement suggéré que les systèmes utilisent etag dans le cycle lecture-modification-écriture pour effectuer des mises à jour d'alerte afin d'éviter les conditions de concurrence: un etag est renvoyé dans la réponse qui contient les alertes, et les systèmes doivent placer cet ETag dans la requête de mise à jour 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 pour mettre à jour l'alerte, l'alerte existante est écrasée à l'aveugle.

AlertMetadata

Métadonnées d'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:

  • NON_DÉMARRÉ
  • IN_PROGRESS (EN_COURS)
  • FERMÉ
assignee

string

Adresse e-mail de l'utilisateur associé à 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'alerte définit ce champ au moment de la création de l'alerte. La valeur par défaut est une chaîne vide lorsqu'il n'a pas pu être déterminé. Les valeurs acceptées pour les actions de mise à jour dans ce champ sont les suivantes:

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

string

Facultatif. etag permet un contrôle de simultanéité optimiste pour éviter que les mises à jour simultanées d'une métadonnée d'alerte ne s'écrasent les unes les autres. Il est fortement suggéré que les systèmes utilisent etag dans le cycle 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 qui contient les métadonnées d'alerte. Les systèmes doivent placer cet ETag dans la requête de mise à jour des métadonnées d'alerte pour 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 pour mettre à jour les métadonnées d'alerte, les métadonnées d'alerte existantes sont alors remplacées à l'aveugle.

Méthodes

batchDelete

Effectue une suppression groupée des alertes.

batchUndelete

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

delete

Permet de marquer l'alerte spécifiée à supprimer.

get

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

getMetadata

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

list

Répertorie les alertes.

undelete

Restaure ou "annule la suppression" d'une alerte qui a été marquée pour suppression au cours des 30 derniers jours.