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. Die Uhrzeit, zu der das Ereignis, das diese Benachrichtigung verursacht hat, gestartet oder erkannt wurde.
endTime

string (Timestamp format)

Optional. Die Uhrzeit, zu der das Ereignis, das diese Benachrichtigung verursacht hat, nicht mehr aktiv war. Falls angegeben, darf die Endzeit nicht vor der Startzeit liegen. Wenn kein Enddatum angegeben ist, handelt es sich um eine laufende Benachrichtigung.
type

string

Erforderlich. Der Typ der Benachrichtigung. Dieser Wert wird erst nach dem Erstellen der Benachrichtigung ausgegeben. Eine Liste der verfügbaren Benachrichtigungstypen finden Sie im Hilfeartikel Benachrichtigungstypen in Google Workspace.
source

string

Erforderlich. Eine eindeutige Kennung für das System, das die Benachrichtigung gemeldet hat. Dieser Wert wird erst nach dem Erstellen der Benachrichtigung ausgegeben.

Folgende Quellen werden unterstützt:

  • Google Operations
  • Mobilgeräteverwaltung
  • Phishing in Gmail
  • Schutz vor Datenverlust
  • Domainweiter Datenexport
  • Staatlich geförderter 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. Datum und Uhrzeit, zu der diese Benachrichtigung zuletzt aktualisiert wurde.
etag

string

Optional. etag wird für eine optimistische Gleichzeitigkeitserkennung verwendet, mit der verhindert werden kann, dass sich gleichzeitige Aktualisierungen einer Benachrichtigung gegenseitig überschreiben. Wir empfehlen dringend, dass Systeme den etag im Read-Modify-Write-Zyklus verwenden, um Benachrichtigungen zu aktualisieren und Race-Bedingungen zu vermeiden: Ein etag wird in der Antwort zurückgegeben, die Benachrichtigungen enthält. Systeme müssen diesen Etag in die Anfrage zum Aktualisieren der Benachrichtigung einfügen, damit die Änderung auf dieselbe Version der Benachrichtigung angewendet wird.

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

AlertMetadata

Metadaten für eine Benachrichtigung.

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, dem die Benachrichtigung zugewiesen ist.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem diese Metadaten zuletzt aktualisiert wurden.
severity

string

Der Schweregrad der Benachrichtigung. Dieses Feld wird vom Benachrichtigungscenter beim Erstellen der Benachrichtigung festgelegt. Wenn es nicht ermittelt werden konnte, ist es standardmäßig ein leerer String. 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. Wir empfehlen dringend, dass Systeme den etag im Read-Modify-Write-Zyklus verwenden, um Metadaten zu aktualisieren und Race-Bedingungen zu vermeiden: In der Antwort, die Benachrichtigungsmetadaten enthält, wird ein etag zurückgegeben. Systeme müssen diesen Etag in die Anfrage zum Aktualisieren von Benachrichtigungsmetadaten einfügen, damit die Änderung auf dieselbe Version der Benachrichtigungsmetadaten angewendet wird.

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

Methoden

batchDelete

 Führt eine Batch-Löschung für Benachrichtigungen aus.

batchUndelete

 Führt eine Batch-Wiederherstellung von Benachrichtigungen aus.

delete

 Die angegebene Benachrichtigung wird zum Löschen markiert.

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.