REST Resource: alerts

Ressource: Benachrichtigung

Eine Benachrichtigung, die einen Kunden betrifft.

JSON-Darstellung 
{
  "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
}
Felder
customerId

string

Nur Ausgabe. Die eindeutige Kennung des Google Workspace-Kontos des Kunden.
alertId

string

Nur Ausgabe. Die eindeutige Kennung für die Benachrichtigung.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem diese Benachrichtigung erstellt wurde.
startTime

string (Timestamp format)

Erforderlich. Der Zeitpunkt, zu dem das Ereignis, das die Benachrichtigung ausgelöst hat, gestartet oder erkannt wurde.
endTime

string (Timestamp format)

Optional. Der Zeitpunkt, zu dem das Ereignis, das diese Benachrichtigung ausgelöst hat, nicht mehr aktiv war. Wenn angegeben, darf die Endzeit nicht vor der Startzeit liegen. Wenn nicht angegeben, wird eine laufende Benachrichtigung angezeigt.
type

string

Erforderlich. Der Typ der Benachrichtigung. Diese Ausgabe wird erst ausgegeben, nachdem die Benachrichtigung erstellt wurde. Eine Liste der verfügbaren Benachrichtigungstypen finden Sie unter Google Workspace-Benachrichtigungstypen.
source

string

Erforderlich. Eine eindeutige Kennung für das System, das die Benachrichtigung gemeldet hat. Diese Ausgabe wird erst ausgegeben, nachdem die Benachrichtigung erstellt wurde.

Folgende Quellen werden unterstützt:

  • Google Operations
  • Mobilgeräteverwaltung
  • Gmail-Phishing
  • Schutz vor Datenverlust
  • Domainweiter Datenexport
  • Angriff mit staatlicher Unterstützung
  • Google-Identität
  • Ausfall von Apps
data

object

Optional. Die mit dieser Benachrichtigung verknüpften Daten, z. B. google.apps.alertcenter.type.DeviceCompromised.
deleted

boolean

Nur Ausgabe. True, wenn diese Benachrichtigung zum Löschen markiert ist.
metadata

object (AlertMetadata)

Nur Ausgabe. Die mit dieser Benachrichtigung verknüpften Metadaten.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt der letzten Aktualisierung dieser Benachrichtigung.
etag

string

Optional. etag wird für eine optimistische Gleichzeitigkeitserkennung verwendet, mit der verhindert werden kann, dass sich gleichzeitige Benachrichtigungen überschreiben. Es wird dringend empfohlen, dass Systeme im Read-Modify-Write-Zyklus zum Aktualisieren von Benachrichtigungen etag verwenden, um Race-Bedingungen zu vermeiden: In der Antwort, die Benachrichtigungen enthält, wird ein etag zurückgegeben. Es wird erwartet, dass Systeme dieses ETag in die Anfrage zur Aktualisierung von Benachrichtigungen aufnehmen, um sicherzustellen, dass ihre Änderung auf dieselbe Benachrichtigungsversion angewendet wird.

Wenn im Aufruf zum Aktualisieren der Benachrichtigung kein etag enthalten ist, wird die vorhandene Benachrichtigung blind überschrieben.

Benachrichtigungsmetadaten

Benachrichtigungsmetadaten.

JSON-Darstellung 
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
Felder
customerId

string

Nur Ausgabe. Die eindeutige Kennung des Google Workspace-Kontos des Kunden.
alertId

string

Nur Ausgabe. Die Benachrichtigungs-ID.
status

string

Der aktuelle Status der Benachrichtigung. Folgende Werte werden unterstützt:

  • NICHT_STARTED
  • IN_PROGRESS
  • GESCHLOSSEN
assignee

string

Die E-Mail-Adresse des Nutzers, der der Benachrichtigung zugewiesen ist.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt der letzten Aktualisierung dieser Metadaten.
severity

string

Der Schweregrad der Benachrichtigung. Die Benachrichtigungszentrale legt dieses Feld zum Zeitpunkt der Benachrichtigungserstellung fest. Standardmäßig wird ein leerer String verwendet, wenn dieser nicht ermittelt werden konnte. Für dieses Feld werden folgende Updatewerte unterstützt:

  • HOCH
  • MEDIUM
  • LOW
etag

string

Optional. etag wird für eine optimistische Gleichzeitigkeitserkennung verwendet, mit der verhindert werden kann, dass sich gleichzeitige Aktualisierungen von Benachrichtigungsmetadaten überschreiben. Es wird dringend empfohlen, dass Systeme im etag-Read-Modify-Write-Zyklus zum Aktualisieren von Metadaten Aktualisierungen verwenden, um Race-Bedingungen zu vermeiden: In der Antwort, die Benachrichtigungsmetadaten enthält, wird ein etag zurückgegeben. Es wird erwartet, dass Systeme dieses ETag in die Anfrage zum Aktualisieren von Benachrichtigungsmetadaten aufnehmen, damit ihre Änderung auf dieselbe Version der Benachrichtigungsmetadaten angewendet wird.

Wenn im Aufruf zum Aktualisieren der Benachrichtigungsmetadaten keine etag enthalten ist, werden die vorhandenen Benachrichtigungsmetadaten blind überschrieben.

Methoden

batchDelete

 Führt einen Batch-Löschvorgang für Benachrichtigungen durch.

batchUndelete

 Führt eine Batch-Wiederherstellung für Benachrichtigungen durch.

delete

 Kennzeichnet die angegebene Benachrichtigung zum Löschen.

get

 Ruft die angegebene Benachrichtigung ab.

getMetadata

 Gibt die Metadaten einer Benachrichtigung zurück.

list

 Listet die Benachrichtigungen auf.

undelete

 Stellt eine Benachrichtigung wieder her, die in den letzten 30 Tagen zum Löschen markiert wurde.