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 der 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 diese Benachrichtigung ausgelöst hat, gestartet oder erkannt wurde.
endTime

string (Timestamp format)

Optional. Der Zeitpunkt, zu dem das Ereignis, das zu dieser Benachrichtigung geführt hat, nicht mehr aktiv war. Falls angegeben, darf das Ende nicht vor dem Beginn liegen. Wenn nicht angegeben, weist dies auf eine laufende Benachrichtigung hin.
type

string

Erforderlich. Der Typ der Benachrichtigung. Sie wird erst ausgegeben, nachdem eine 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. Sie wird erst ausgegeben, nachdem eine Benachrichtigung erstellt wurde.

Folgende Quellen werden unterstützt:

  • Google-Vorfallmanagement
  • Mobilgeräteverwaltung
  • Phishing in Gmail
  • Schutz vor Datenverlust
  • Domainweiter Datenexport
  • Staatlicher Angriff
  • 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 Aktualisierungen einer Benachrichtigung gegenseitig überschreiben. Es wird dringend empfohlen, dass Systeme im Lese-, Änderungs- und Schreibzyklus das etag verwenden, um Benachrichtigungsaktualisierungen durchzuführen, um Race-Bedingungen zu vermeiden: In der Antwort, die Benachrichtigungen enthält, wird ein etag zurückgegeben, das Benachrichtigungen enthält. Es wird erwartet, dass Systeme dieses ETag in die Benachrichtigungsanfrage einfügen, damit ihre Änderung auf dieselbe Version der Benachrichtigung angewendet wird.

Wenn in der Benachrichtigung zum Aktualisieren kein etag angegeben ist, wird die vorhandene Benachrichtigung blind überschrieben.

AlertMetadata

Metadaten für Benachrichtigungen.

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:

  • NOT_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. In der Benachrichtigungszentrale wird dieses Feld beim Erstellen der Benachrichtigung festgelegt. Wenn es nicht ermittelt werden konnte, wird standardmäßig ein leerer String verwendet. Folgende Werte werden für Aktualisierungsaktionen für dieses Feld unterstützt:

  • HOCH
  • MEDIUM
  • NIEDRIG
etag

string

Optional. etag wird für eine optimistische Gleichzeitigkeitserkennung verwendet, mit der verhindert werden kann, dass sich gleichzeitige Aktualisierungen von Benachrichtigungsmetadaten gegenseitig überschreiben. Es wird dringend empfohlen, dass Systeme das etag im Lese-, Änderungs- und Schreibzyklus verwenden, um Metadatenaktualisierungen durchzuführen, um Race-Bedingungen zu vermeiden: In der Antwort wird ein etag zurückgegeben, das Benachrichtigungsmetadaten enthält. Es wird erwartet, dass Systeme dieses ETag in die Anfrage zum Aktualisieren von Benachrichtigungsmetadaten einfügen, damit ihre Änderung auf dieselbe Version der Benachrichtigungsmetadaten angewendet wird.

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

Methoden

batchDelete

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

batchUndelete

 Führt einen Batch-Wiederherstellungsvorgang für Benachrichtigungen aus.

delete

 Markiert 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 innerhalb der letzten 30 Tage zum Löschen markiert wurde.