ภาพรวมของ Mail Admin Quarantine API

Mail Admin Quarantine API ช่วยให้ผู้ดูแลระบบ Google Workspace สามารถจัดการข้อความอีเมลที่ Gmail เก็บไว้ในเขตกักบริเวณของผู้ดูแลระบบแบบเป็นโปรแกรมได้ ข้อความจะถูกกักเก็บเมื่อตรงกับการปฏิบัติตามข้อกำหนด การป้องกันข้อมูลรั่วไหล (DLP) หรือกฎความปลอดภัยที่คุณกำหนดค่าไว้ในคอนโซลผู้ดูแลระบบของ Google

ใช้ API เพื่อสร้างการทำงานอัตโนมัติด้านความปลอดภัยและการปฏิบัติตามข้อกำหนด เช่น

  • การดึงข้อความที่กักบริเวณไว้ไปยังแพลตฟอร์ม SIEM หรือ SOAR เพื่อคัดแยก
  • ตรวจสอบส่วนหัวของข้อความ ตัวอย่างเนื้อความ และไฟล์แนบก่อนตัดสินใจว่าจะจัดการกับข้อความอย่างไร
  • การนำส่งข้อความที่ปลอดภัยและปฏิเสธข้อความที่ไม่ปลอดภัย โดยจะดำเนินการทีละข้อความหรือเป็นกลุ่มสูงสุด 500 ข้อความ

แหล่งข้อมูลสำคัญ

Admin Quarantine API จะแสดงทรัพยากรต่อไปนี้ภายใต้ลูกค้า

ทรัพยากร ชื่อทรัพยากร คำอธิบาย
ลูกค้า customers/CUSTOMER_ID บัญชี Google Workspace ของคุณ โปรดดูรายละเอียดที่หัวข้อค้นหารหัสลูกค้า
customers.quarantinedMessages customers/CUSTOMER_ID/quarantinedMessages/MESSAGE_OWNER:MESSAGE_ID ข้อความอีเมลที่เก็บไว้ในเขตกักบริเวณ MESSAGE_OWNER คืออีเมลของเจ้าของกล่องจดหมาย และ MESSAGE_ID คือรหัสข้อความ Gmail ที่เปลี่ยนแปลงไม่ได้
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: เข้าร่วมโปรแกรมตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ เปิดใช้ API ในโปรเจ็กต์ Google Cloud ค้นหารหัสลูกค้า และให้สิทธิ์ผู้ดูแลระบบที่จำเป็น
  2. ให้สิทธิ์ด้วยการมอบสิทธิ์ทั่วทั้งโดเมน: สร้างบัญชีบริการ กำหนดค่าการมอบสิทธิ์ทั่วทั้งโดเมนด้วยขอบเขต Admin Quarantine API และรับโทเค็นเพื่อการเข้าถึงที่แอบอ้างเป็นผู้ดูแลระบบ
  3. คัดแยกข้อความ:
    1. แสดงรายการและค้นหาข้อความที่กักเก็บไว้
    2. ดูรายละเอียดข้อความ
    3. ปล่อยหรือปฏิเสธข้อความ หรือปล่อยหรือปฏิเสธข้อความหลายรายการพร้อมกัน
  4. ใช้งานภายในโควต้าการใช้งาน

การบันทึกการตรวจสอบ

การเรียก API ทุกครั้งที่อ่านหรือเปลี่ยนแปลงข้อความที่กักบริเวณจะได้รับการบันทึกไว้ในบันทึกการตรวจสอบของคอนโซลผู้ดูแลระบบ โดยระบุว่าเป็นของผู้ดูแลระบบที่เรียกใช้คำขอ

ขั้นตอนถัดไป