Omówienie interfejsu Mail Admin Quarantine API

Interfejs Mail Admin Quarantine API umożliwia administratorom Google Workspace automatyczne zarządzanie e-mailami, które Gmail przechowuje w kwarantannie administracyjnej. Wiadomości trafiają do kwarantanny, gdy są zgodne z regułami zgodności, zapobiegania utracie danych (DLP) lub bezpieczeństwa skonfigurowanymi w konsoli administracyjnej Google.

Za pomocą interfejsu API możesz tworzyć automatyzacje zabezpieczeń i zgodności, takie jak:

  • pobieranie wiadomości poddanych kwarantannie na platformę SIEM lub SOAR w celu ich oceny;
  • sprawdzanie nagłówków wiadomości, fragmentów treści i załączników przed podjęciem decyzji o tym, co zrobić z wiadomością;
  • Zatwierdzanie bezpiecznych wiadomości i odrzucanie niebezpiecznych – pojedynczo lub w partiach do 500 wiadomości.

Najważniejsze zasoby

Interfejs Admin Quarantine API udostępnia te zasoby w ramach klienta:

Zasób Nazwa zasobu Opis
Klient customers/CUSTOMER_ID Twoje konto Google Workspace. Więcej informacji znajdziesz w artykule Znajdowanie identyfikatora klienta.
customers.quarantinedMessages customers/CUSTOMER_ID/quarantinedMessages/MESSAGE_OWNER:MESSAGE_ID Wiadomość e-mail umieszczona w kwarantannie. MESSAGE_OWNER to adres e-mail właściciela skrzynki pocztowej, a MESSAGE_ID to niezmienny identyfikator wiadomości w Gmailu.
customers.quarantines customers/CUSTOMER_ID/quarantines/QUARANTINE_ID Kwarantanna skonfigurowana w konsoli administracyjnej.
customers.operations customers/CUSTOMER_ID/operations/OPERATION_ID Długo trwająca operacja, która śledzi żądanie zbiorczego zwolnienia lub zbiorczej odmowy.

Obiekt QuarantinedMessage zawiera jeden z tych obiektów State:

Stan Opis
PENDING_TRIAGE Wiadomość jest przechowywana w kwarantannie i oczekuje na decyzję administratora.
RELEASED Administrator zwolnił wiadomość, a Gmail ją dostarczył.
DENIED Administrator odrzucił wiadomość, a Gmail ją usunął.

Metody

Wszystkie żądania są kierowane na https://mailadminquarantine.googleapis.com/v1.

Metoda Żądanie HTTP Opis
customers.quarantinedMessages.list GET /customers/*/quarantinedMessages Wyświetla listę wiadomości poddanych kwarantannie z ostatnich 30 dni.
customers.quarantinedMessages.search POST /customers/*/quarantinedMessages:search Wyszukuje wiadomości poddane kwarantannie za pomocą filtra lub zapytania wyszukiwania w Gmailu.
customers.quarantinedMessages.get GET /customers/*/quarantinedMessages/* Pobiera metadane, przeanalizowaną treść lub nieprzetworzoną wiadomość RFC 2822.
customers.quarantinedMessages.release POST /customers/*/quarantinedMessages/*:release Zezwala na dostarczenie pojedynczej wiadomości.
customers.quarantinedMessages.deny POST /customers/*/quarantinedMessages/*:deny Odrzuca pojedynczą wiadomość.
customers.quarantinedMessages.batchRelease POST /customers/*/quarantinedMessages:batchRelease Asynchronicznie zwalnia do 500 wiadomości.
customers.quarantinedMessages.batchDeny POST /customers/*/quarantinedMessages:batchDeny Asynchronicznie odrzuca maksymalnie 500 wiadomości.
customers.operations.get GET /customers/*/operations/* Pobiera stan i wyniki operacji wsadowej.
customers.quarantines.list GET /customers/*/quarantines Wyświetla listę kwarantann skonfigurowanych dla klienta.
customers.quarantines.get GET /customers/*/quarantines/* Pobiera wyświetlaną nazwę i opis kwarantanny.

Ogólne etapy implementacji

  1. Skonfiguruj interfejs API: dołącz do programu wersji przedpremierowej dla programistów, włącz interfejs API w projekcie Google Cloud, znajdź identyfikator klienta i przyznaj wymagane uprawnienia administratora.
  2. Autoryzacja z przekazywaniem dostępu w całej domenie: utwórz konto usługi, skonfiguruj przekazywanie dostępu w całej domenie z zakresami interfejsu Admin Quarantine API i uzyskaj token dostępu, który umożliwia podszywanie się pod administratora.
  3. Segregowanie wiadomości:
    1. Wyświetlanie i wyszukiwanie wiadomości w kwarantannie
    2. Wyświetlanie szczegółów wiadomości
    3. Zatwierdź lub odrzuć wiadomość lub zatwierdź lub odrzuć wiadomości zbiorczo.
  4. nie przekraczać limitów wykorzystania,

Logowanie kontrolne

Każde wywołanie interfejsu API, które odczytuje lub zmienia wiadomości poddane kwarantannie, jest rejestrowane w dziennikach kontroli i analizy zagrożeń w konsoli administracyjnej i przypisywane do administratora, w imieniu którego jest wykonywane żądanie.

Dalsze kroki