Ringkasan Mail Admin Quarantine API

Mail Admin Quarantine API memungkinkan administrator Google Workspace mengelola pesan email yang disimpan Gmail di karantina admin secara terprogram. Pesan akan masuk ke karantina jika cocok dengan aturan kepatuhan, pencegahan kebocoran data (DLP), atau keamanan yang Anda konfigurasi di konsol Google Admin.

Gunakan API untuk membangun otomatisasi keamanan dan kepatuhan, seperti:

  • Mengambil pesan yang dikarantina ke platform SIEM atau SOAR untuk triase.
  • Meninjau header pesan, cuplikan isi, dan lampiran sebelum memutuskan cara menangani pesan.
  • Merilis pesan yang aman dan menolak pesan yang tidak aman, secara individual atau dalam batch hingga 500 pesan.

Referensi penting

Admin Quarantine API mengekspos resource berikut di bagian pelanggan:

Resource Nama resource Deskripsi
Pelanggan customers/CUSTOMER_ID Akun Google Workspace Anda. Untuk mengetahui detailnya, lihat Menemukan ID pelanggan Anda.
customers.quarantinedMessages customers/CUSTOMER_ID/quarantinedMessages/MESSAGE_OWNER:MESSAGE_ID Pesan email yang disimpan di karantina. MESSAGE_OWNER adalah alamat email pemilik kotak surat dan MESSAGE_ID adalah ID pesan Gmail yang tidak dapat diubah.
customers.quarantines customers/CUSTOMER_ID/quarantines/QUARANTINE_ID Karantina yang Anda konfigurasi di konsol Admin.
customers.operations customers/CUSTOMER_ID/operations/OPERATION_ID Operasi yang berjalan lama yang melacak permintaan rilis batch atau penolakan batch.

QuarantinedMessage berisi salah satu objek State berikut:

Negara Bagian Deskripsi
PENDING_TRIAGE Pesan disimpan di karantina dan menunggu keputusan administrator.
RELEASED Administrator merilis pesan dan Gmail mengirimkannya.
DENIED Administrator menolak pesan dan Gmail menghapusnya.

Metode

Semua permintaan menargetkan https://mailadminquarantine.googleapis.com/v1.

Metode Permintaan HTTP Deskripsi
customers.quarantinedMessages.list GET /customers/*/quarantinedMessages Mencantumkan pesan yang dikarantina dari 30 hari terakhir.
customers.quarantinedMessages.search POST /customers/*/quarantinedMessages:search Menelusuri pesan yang dikarantina menggunakan filter atau kueri penelusuran Gmail.
customers.quarantinedMessages.get GET /customers/*/quarantinedMessages/* Mendapatkan metadata, konten yang diuraikan, atau pesan RFC 2822 mentah.
customers.quarantinedMessages.release POST /customers/*/quarantinedMessages/*:release Melepaskan satu pesan untuk dikirimkan.
customers.quarantinedMessages.deny POST /customers/*/quarantinedMessages/*:deny Menolak satu pesan.
customers.quarantinedMessages.batchRelease POST /customers/*/quarantinedMessages:batchRelease Merilis hingga 500 pesan secara asinkron.
customers.quarantinedMessages.batchDeny POST /customers/*/quarantinedMessages:batchDeny Menolak hingga 500 pesan secara asinkron.
customers.operations.get GET /customers/*/operations/* Mendapatkan status dan hasil operasi batch.
customers.quarantines.list GET /customers/*/quarantines Mencantumkan karantina yang dikonfigurasi untuk pelanggan.
customers.quarantines.get GET /customers/*/quarantines/* Mendapatkan nama tampilan dan deskripsi karantina.

Langkah-langkah penerapan umum

  1. Menyiapkan API: bergabunglah dengan Program Pratinjau Developer, aktifkan API di project Google Cloud Anda, temukan ID pelanggan Anda, dan berikan hak istimewa administrator yang diperlukan.
  2. Memberikan otorisasi dengan delegasi tingkat domain: buat akun layanan, konfigurasikan delegasi tingkat domain dengan cakupan Admin Quarantine API, dan dapatkan token akses yang meniru identitas administrator.
  3. Pesan triase:
    1. Mencantumkan dan menelusuri pesan yang dikarantina.
    2. Mendapatkan detail pesan.
    3. Melepaskan atau menolak pesan, atau melepaskan atau menolak pesan dalam batch.
  4. Tetap berada dalam kuota penggunaan.

Logging audit

Setiap panggilan API yang membaca atau mengubah pesan yang dikarantina dicatat dalam log audit dan investigasi konsol Admin, yang dikaitkan dengan administrator yang menjalankan permintaan tersebut.

Langkah berikutnya