Mail Admin Quarantine API を使用すると、Google Workspace 管理者は、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 |
1 つのメッセージを拒否します。 |
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/* |
検疫の表示名と説明を取得します。 |
実装手順の概要
- API を設定する: デベロッパー プレビュー プログラムに参加し、Google Cloud プロジェクトで API を有効にして、お客様 ID を確認し、必要な管理者権限を付与します。
- ドメイン全体の委任で承認する: サービス アカウントを作成し、Admin Quarantine API スコープでドメイン全体の委任を構成して、管理者の権限を借用するアクセス トークンを取得します。
- メッセージをトリアージする:
- 使用量の割り当て内に収める。
監査ロギング
検疫されたメールを読み取るか変更するすべての API 呼び出しは、管理コンソールの監査と調査ログに記録され、リクエストを実行した管理者に関連付けられます。
次のステップ
- Admin Quarantine API を設定する
- 管理コンソール ヘルプセンターのメール検疫の設定と管理