Обзор 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, который считывает или изменяет сообщения в карантине, записывается в журналы аудита и анализа консоли администратора и связывается с администратором, от имени которого выполняется запрос.

Дальнейшие действия