Mail Admin Quarantine API מאפשר לאדמינים ב-Google Workspace לנהל באופן פרוגרמטי הודעות אימייל ש-Gmail מחזיק בהסגר בניהול האדמין. הודעות מועברות להסגר כשהן תואמות לכללי תאימות, לכללים למניעת אובדן נתונים (DLP) או לכללי אבטחה שהגדרתם במסוף Google Admin.
אתם יכולים להשתמש ב-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 |
הסגר שהגדרתם במסוף Admin. |
customers.operations |
customers/CUSTOMER_ID/operations/OPERATION_ID |
פעולה ממושכת שעוקבת אחרי בקשה לאישור או לדחייה של כמות גדולה של פריטים. |
QuarantinedMessage מכיל אחד מהאובייקטים הבאים של State:
| מדינה (State) | תיאור |
|---|---|
PENDING_TRIAGE |
ההודעה מוחזקת בהסגר וממתינה להחלטת האדמין. |
RELEASED |
אדמין שחרר את ההודעה ו-Gmail העביר אותה. |
DENIED |
אדמין דחה את ההודעה ו-Gmail הסיר אותה. |
Methods
כל הבקשות מטרגטות את 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/* |
מקבל את השם המוצג והתיאור של ההסגר. |
שלבי ההטמעה העיקריים
- הגדרת ה-API: הצטרפות לתוכנית 'תצוגה מקדימה למפתחים', הפעלת ה-API בפרויקט בענן ב-Google Cloud, איתור מספר הלקוח והענקת הרשאת האדמין הנדרשת.
- אישור באמצעות הענקת גישה ברמת הדומיין: יוצרים חשבון שירות, מגדירים הענקת גישה ברמת הדומיין עם ההיקפים של Admin Quarantine API ומקבלים אסימון גישה שמתחזה לאדמין.
- הודעות טיפול:
- לא לחרוג ממכסות השימוש.
רישום ביומן ביקורת
כל קריאה ל-API שקוראת או משנה הודעות בהסגר מתועדת ביומני הביקורת והחקירה במסוף Admin, ומשויכת לאדמין שהבקשה פועלת בשמו.
השלבים הבאים
- הגדרת Admin Quarantine API
- הגדרה וניהול של הסגרים לאימייל במרכז העזרה של מסוף Admin