Mail Admin Quarantine API به سرپرستان Google Workspace اجازه می‌دهد پیام‌های ایمیلی را که Gmail در قرنطینه سرپرست نگه می‌دارد به‌صورت برنامه‌نویسی‌شده مدیریت کنند. پیام‌ها زمانی به قرنطینه می‌روند که با قوانین مطابقت، جلوگیری از ازبین رفتن داده‌ها (DLP)، یا قوانین امنیتی که در کنسول Google Admin پیکربندی کرده‌اید مطابقت داشته باشند.
از API برای ساختن خودکارسازی‌های امنیتی و رعایت مقررات استفاده کنید، ازجمله:
- بازیابی پیام‌های قرنطینه‌شده در پلاتفرم SIEM یا SOAR برای تریاژ.
- سرصفحه پیام، گزیده‌های متن، و پیوست‌ها را قبل‌از تصمیم‌گیری درباره نحوه رسیدگی به پیام بررسی می‌کند.
- انتشار پیام‌هایی که ایمن هستند و رد کردن پیام‌هایی که ایمن نیستند، به‌صورت تکی یا در دسته‌های حداکثر ۵۰۰ تایی.
منابع اصلی
«میانای برنامه‌سازی کاربردی قرنطینه سرپرست» منابع زیر را تحت مشتری نشان می‌دهد:
| منبع | نام منبع | شرح |
|---|---|---|
| مشتری | 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 |
پیام‌های قرنطینه‌شده ۳۰ روز گذشته را فهرست می‌کند. |
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 |
حداکثر ۵۰۰ پیام را به‌صورت ناهمگام منتشر می‌کند. |
customers.quarantinedMessages.batchDeny |
POST /customers/*/quarantinedMessages:batchDeny |
به‌طور ناهمگام تا ۵۰۰ پیام را رد می‌کند. |
customers.operations.get |
GET /customers/*/operations/* |
وضعیت و نتایج عملیات دسته‌ای را دریافت می‌کند. |
customers.quarantines.list |
GET /customers/*/quarantines |
قرنطینه‌های پیکربندی‌شده برای مشتری را فهرست می‌کند. |
customers.quarantines.get |
GET /customers/*/quarantines/* |
نام نمایشی و شرح قرنطینه را دریافت می‌کند. |
مراحل پیاده‌سازی سطح بالا
- راه‌اندازی میانای برنامه‌سازی کاربردی: به «برنامه پیش‌نمایش توسعه‌دهندگان نرم‌افزار» بپیوندید، میانای برنامه‌سازی کاربردی را در پروژه Google Cloud خود فعال کنید، شناسه مشتری‌تان را پیدا کنید، و امتیاز سرپرست لازم را اعطا کنید.
- مجوز دادن با واگذاری در سطح دامنه: حساب سرویس ایجاد کنید، واگذاری در سطح دامنه را با گستره‌های Admin Quarantine API پیکربندی کنید، و کد دسترسی‌ای دریافت کنید که خود را به‌جای سرپرست جا می‌زند.
- پیام‌های تریاژ:
- در محدوده سهمیه‌های استفاده بمانید.
گزارش‌گیری ممیزی
هر فراخوانی میانای برنامه‌سازی کاربردی که پیام‌های قرنطینه‌شده را می‌خواند یا تغییر می‌دهد در گزارش‌های ممیزی و بررسی کنسول «سرپرست» ثبت می‌شود و به سرپرستی که درخواست را اجرا می‌کند نسبت داده می‌شود.
مراحل بعدی
- راه‌اندازی Admin Quarantine API
- راه‌اندازی و مدیریت قرنطینه ایمیل در «مرکز راهنمایی» کنسول سرپرست