Mail Admin Quarantine API 總覽

Google Workspace 管理員可透過 Mail Admin Quarantine API，以程式輔助方式管理 Gmail 保留在管理員隔離區中的電子郵件訊息。如果郵件符合您在 Google 管理控制台中設定的法規遵循、資料遺失防護 (DLP) 或安全性規則，就會進入隔離區。

使用 API 建構安全性與法規遵循自動化功能，例如：

  • 將隔離郵件擷取至 SIEM 或 SOAR 平台，以便進行分類。
  • 在決定如何處理郵件前，先查看郵件標頭、內文片段和附件。
  • 釋出安全的郵件，並拒絕不安全的郵件，可個別處理或批次處理，最多可達 500 封郵件。

重要資源

Admin Quarantine API 會在客戶底下公開下列資源：

資源 資源名稱 說明
客戶 customers/CUSTOMER_ID 您的 Google Workspace 帳戶。詳情請參閱「查看客戶 ID」。
customers.quarantinedMessages customers/CUSTOMER_ID/quarantinedMessages/MESSAGE_OWNER:MESSAGE_ID 隔離區中的電子郵件訊息。MESSAGE_OWNER 是信箱擁有者的電子郵件地址，MESSAGE_ID 則是不可變更的 Gmail 郵件 ID。
customers.quarantines customers/CUSTOMER_ID/quarantines/QUARANTINE_ID 您在管理控制台中設定的隔離區。
customers.operations customers/CUSTOMER_ID/operations/OPERATION_ID 追蹤批次釋出或批次拒絕要求的長時間執行的作業。

QuarantinedMessage 包含下列其中一個 State 物件：

州 說明
PENDING_TRIAGE 郵件會保留在隔離區，等待管理員決定如何處理。
RELEASED 管理員釋出郵件，Gmail 已傳送郵件。
DENIED 管理員拒絕郵件，Gmail 捨棄郵件。

方法

所有要求都指定 https://mailadminquarantine.googleapis.com/v1。

方法 HTTP 要求 說明
customers.quarantinedMessages.list GET /customers/*/quarantinedMessages 列出過去 30 天內隔離的郵件。
customers.quarantinedMessages.search POST /customers/*/quarantinedMessages:search 使用篩選器或 Gmail 搜尋查詢，搜尋隔離郵件。
customers.quarantinedMessages.get GET /customers/*/quarantinedMessages/* 取得中繼資料、剖析後的內容或原始 RFC 2822 郵件。
customers.quarantinedMessages.release POST /customers/*/quarantinedMessages/*:release 允許傳送單一郵件。
customers.quarantinedMessages.deny POST /customers/*/quarantinedMessages/*:deny 拒絕單一訊息。
customers.quarantinedMessages.batchRelease POST /customers/*/quarantinedMessages:batchRelease 以非同步方式釋出最多 500 則訊息。
customers.quarantinedMessages.batchDeny POST /customers/*/quarantinedMessages:batchDeny 以非同步方式拒絕最多 500 則訊息。
customers.operations.get GET /customers/*/operations/* 取得批次作業的狀態和結果。
customers.quarantines.list GET /customers/*/quarantines 列出為客戶設定的隔離區。
customers.quarantines.get GET /customers/*/quarantines/* 取得隔離區的顯示名稱和說明。

導入步驟概覽

  1. 設定 API：加入開發人員預覽計畫、在 Google Cloud 專案中啟用 API、找出客戶 ID，並授予必要的管理員權限。
  2. 使用全網域委派功能授權：建立服務帳戶、使用 Admin Quarantine API 範圍設定全網域委派功能，並取得模擬管理員的存取權杖。
  3. 分類訊息：
    1. 列出及搜尋隔離郵件。
    2. 取得訊息詳細資料。
    3. 放行或拒絕郵件，或批次放行或拒絕郵件。
  4. 不超過用量配額。

稽核記錄

凡是讀取或變更隔離郵件的 API 呼叫，都會記錄在管理控制台的稽核與調查記錄中，並歸因於執行要求的管理員。

後續步驟