Mail Admin Quarantine API – Übersicht

Mit der Mail Admin Quarantine API können Google Workspace-Administratoren E‑Mail-Nachrichten, die von Gmail in einer Admin-Quarantäne aufbewahrt werden, programmatisch verwalten. Nachrichten werden in eine Quarantäne verschoben, wenn sie den Compliance-, DLP- (Data Loss Prevention, Schutz vor Datenverlust) oder Sicherheitsregeln entsprechen, die Sie in der Admin-Konsole konfiguriert haben.

Mit der API können Sie Automatisierungen für Sicherheit und Compliance erstellen, z. B.:

  • Abrufen von Nachrichten in Quarantäne in eine SIEM- oder SOAR-Plattform zur Triage.
  • Überprüfen Sie die Nachrichtenheader, Textausschnitte und Anhänge, bevor Sie entscheiden, wie Sie mit einer Nachricht verfahren.
  • Sichere Nachrichten freigeben und unsichere Nachrichten ablehnen, einzeln oder in Gruppen von bis zu 500 Nachrichten.

Wichtige Ressourcen

Die Admin Quarantine API stellt die folgenden Ressourcen für einen Kunden bereit:

Ressource Ressourcenname Beschreibung
Kunde customers/CUSTOMER_ID Ihr Google Workspace-Konto Weitere Informationen finden Sie unter Kundennummer ermitteln.
customers.quarantinedMessages customers/CUSTOMER_ID/quarantinedMessages/MESSAGE_OWNER:MESSAGE_ID Eine E‑Mail-Nachricht, die unter Quarantäne gestellt wurde. MESSAGE_OWNER ist die E‑Mail-Adresse des Postfachinhabers und MESSAGE_ID ist die unveränderliche Gmail-Nachrichten-ID.
customers.quarantines customers/CUSTOMER_ID/quarantines/QUARANTINE_ID Eine Quarantäne, die Sie in der Admin-Konsole konfiguriert haben.
customers.operations customers/CUSTOMER_ID/operations/OPERATION_ID Ein Vorgang mit langer Ausführungszeit, der eine Batchfreigabe- oder Batchablehnungsanfrage verfolgt.

Ein QuarantinedMessage enthält eines der folgenden State-Objekte:

Bundesland Beschreibung
PENDING_TRIAGE Die Nachricht wird in einer Quarantäne aufbewahrt und wartet auf eine Entscheidung des Administrators.
RELEASED Ein Administrator hat die Nachricht freigegeben und Gmail hat sie zugestellt.
DENIED Ein Administrator hat die Nachricht abgelehnt und Gmail hat sie gelöscht.

Methoden

Alle Anfragen sind auf https://mailadminquarantine.googleapis.com/v1 ausgerichtet.

Methode HTTP-Anfrage Beschreibung
customers.quarantinedMessages.list GET /customers/*/quarantinedMessages Listet Nachrichten auf, die in den letzten 30 Tagen in Quarantäne verschoben wurden.
customers.quarantinedMessages.search POST /customers/*/quarantinedMessages:search Sucht mithilfe eines Filters oder einer Gmail-Suchanfrage nach Nachrichten in Quarantäne.
customers.quarantinedMessages.get GET /customers/*/quarantinedMessages/* Ruft Metadaten, geparste Inhalte oder die RFC 2822-Rohdaten der Nachricht ab.
customers.quarantinedMessages.release POST /customers/*/quarantinedMessages/*:release Gibt eine einzelne Nachricht zur Zustellung frei.
customers.quarantinedMessages.deny POST /customers/*/quarantinedMessages/*:deny Lehnt eine einzelne Nachricht ab.
customers.quarantinedMessages.batchRelease POST /customers/*/quarantinedMessages:batchRelease Gibt asynchron bis zu 500 Nachrichten frei.
customers.quarantinedMessages.batchDeny POST /customers/*/quarantinedMessages:batchDeny Lehnt asynchron bis zu 500 Nachrichten ab.
customers.operations.get GET /customers/*/operations/* Ruft den Status und die Ergebnisse eines Batchvorgangs ab.
customers.quarantines.list GET /customers/*/quarantines Listet die für den Kunden konfigurierten Quarantänen auf.
customers.quarantines.get GET /customers/*/quarantines/* Ruft den Anzeigenamen und die Beschreibung einer Quarantäne ab.

Allgemeine Implementierungsschritte

  1. API einrichten: Nehmen Sie am Entwicklervorschauprogramm teil, aktivieren Sie die API in Ihrem Google Cloud-Projekt, suchen Sie Ihre Kundennummer und gewähren Sie die erforderliche Administratorberechtigung.
  2. Mit domainweiter Delegierung autorisieren: Erstellen Sie ein Dienstkonto, konfigurieren Sie die domainweite Delegierung mit den Bereichen der Admin Quarantine API und rufen Sie ein Zugriffstoken ab, das einen Administrator imitiert.
  3. Nachrichten priorisieren:
    1. Nachrichten in Quarantäne auflisten und suchen
    2. Nachrichtendetails abrufen
    3. Nachrichten freigeben oder ablehnen oder Nachrichten im Batch freigeben oder ablehnen.
  4. Bleiben Sie innerhalb der Nutzungskontingente.

Audit-Logging

Jeder API-Aufruf, der Nachrichten in Quarantäne liest oder ändert, wird in den Audit- und Prüfprotokollen der Admin-Konsole aufgezeichnet und dem Administrator zugeordnet, als der die Anfrage ausgeführt wird.

Nächste Schritte