Mail Admin Quarantine API'ye genel bakış

Mail Admin Quarantine API, Google Workspace yöneticilerinin Gmail'in yönetici karantinasında tuttuğu e-posta iletilerini programatik olarak yönetmesine olanak tanır. Google Yönetici Konsolu'nda yapılandırdığınız uygunluk, Veri Kaybını Önleme (DLP) veya güvenlik kurallarıyla eşleşen iletiler karantinaya alınır.

API'yi kullanarak güvenlik ve uygunluk otomasyonları oluşturabilirsiniz. Örneğin:

  • Karantinaya alınmış iletileri önceliklendirme için bir SIEM veya SOAR platformuna alma.
  • Bir iletinin nasıl işleneceğine karar vermeden önce ileti üstbilgilerini, gövde snippet'lerini ve ekleri inceleme.
  • Güvenli iletileri serbest bırakma ve güvenli olmayan iletileri tek tek veya 500 iletiye kadar toplu olarak reddetme.

Önemli kaynaklar

Admin Quarantine API, bir müşteri altında aşağıdaki kaynakları gösterir:

Kaynak Kaynak adı Açıklama
Müşteri customers/CUSTOMER_ID Google Workspace hesabınız Ayrıntılar için Müşteri kimliğinizi bulma başlıklı makaleyi inceleyin.
customers.quarantinedMessages customers/CUSTOMER_ID/quarantinedMessages/MESSAGE_OWNER:MESSAGE_ID Karantinada tutulan bir e-posta iletisi. MESSAGE_OWNER, posta kutusu sahibinin e-posta adresidir ve MESSAGE_ID, sabit Gmail ileti kimliğidir.
customers.quarantines customers/CUSTOMER_ID/quarantines/QUARANTINE_ID Yönetici Konsolu'nda yapılandırdığınız bir karantina.
customers.operations customers/CUSTOMER_ID/operations/OPERATION_ID Toplu yayınlama veya toplu reddetme isteğini izleyen uzun süreli bir işlem.

QuarantinedMessage, aşağıdaki State nesnelerinden birini içerir:

Eyalet Açıklama
PENDING_TRIAGE İleti karantinada tutuluyor ve bir yöneticinin kararını bekliyor.
RELEASED Bir yönetici iletiyi serbest bıraktı ve Gmail iletiyi teslim etti.
DENIED Bir yönetici iletiyi reddetti ve Gmail iletiyi sildi.

Yöntemler

Tüm istekler https://mailadminquarantine.googleapis.com/v1 hedefini kullanıyor.

Yöntem HTTP isteği Açıklama
customers.quarantinedMessages.list GET /customers/*/quarantinedMessages Son 30 güne ait karantinaya alınmış iletileri listeler.
customers.quarantinedMessages.search POST /customers/*/quarantinedMessages:search Filtre veya Gmail arama sorgusu kullanarak karantinaya alınan iletileri arar.
customers.quarantinedMessages.get GET /customers/*/quarantinedMessages/* Meta verileri, ayrıştırılmış içeriği veya ham RFC 2822 iletisini alır.
customers.quarantinedMessages.release POST /customers/*/quarantinedMessages/*:release Tek bir iletiyi teslim edilmek üzere serbest bırakır.
customers.quarantinedMessages.deny POST /customers/*/quarantinedMessages/*:deny Tek bir mesajı reddeder.
customers.quarantinedMessages.batchRelease POST /customers/*/quarantinedMessages:batchRelease Eşzamansız olarak en fazla 500 iletiyi serbest bırakır.
customers.quarantinedMessages.batchDeny POST /customers/*/quarantinedMessages:batchDeny En fazla 500 iletiyi eşzamansız olarak reddeder.
customers.operations.get GET /customers/*/operations/* Toplu işlemin durumunu ve sonuçlarını alır.
customers.quarantines.list GET /customers/*/quarantines Müşteri için yapılandırılan karantinaları listeler.
customers.quarantines.get GET /customers/*/quarantines/* Karantinanın görünen adını ve açıklamasını alır.

Üst düzey uygulama adımları

  1. API'yi ayarlama: Geliştirici Önizleme Programı'na katılın, Google Cloud projenizde API'yi etkinleştirin, müşteri kimliğinizi bulun ve gerekli yönetici ayrıcalığını verin.
  2. Alan genelinde yetkiyle yetkilendirme: Bir hizmet hesabı oluşturun, Admin Quarantine API kapsamlarıyla alan genelinde yetkiyi yapılandırın ve bir yöneticinin kimliğine bürünen erişim jetonu alın.
  3. Mesajları önceliklendirme:
    1. Karantinaya alınan iletileri listeleme ve arama
    2. Mesaj ayrıntılarını alma
    3. Bir iletiyi serbest bırakma veya reddetme veya İletileri toplu olarak serbest bırakma veya reddetme
  4. Kullanım kotalarını aşmayın.

Denetleme günlüğü

Karantinaya alınmış iletileri okuyan veya değiştiren her API çağrısı, Yönetici Konsolu'ndaki denetim ve inceleme günlüklerine kaydedilir ve isteği çalıştıran yöneticiyle ilişkilendirilir.

Sonraki adımlar