Descripción general de la API de Mail Admin Quarantine

La API de Mail Admin Quarantine permite que los administradores de Google Workspace administren de forma programática los mensajes de correo electrónico que Gmail retiene en una cuarentena de administrador. Los mensajes se ponen en cuarentena cuando coinciden con las reglas de cumplimiento, prevención de pérdida de datos (DLP) o seguridad que configuras en la Consola del administrador de Google.

Usa la API para compilar automatizaciones de seguridad y cumplimiento, como las siguientes:

  • Recuperar mensajes en cuarentena en una plataforma de SIEM o SOAR para su clasificación
  • Revisar los encabezados de los mensajes, los fragmentos del cuerpo y los archivos adjuntos antes de decidir cómo manejar un mensaje
  • Liberar los mensajes que son seguros y rechazar los que no lo son, ya sea de forma individual o en lotes de hasta 500 mensajes

Recursos clave

La API de Admin Quarantine expone los siguientes recursos en un cliente:

Recurso Nombre del recurso Descripción
Cliente customers/CUSTOMER_ID Tu cuenta de Google Workspace Para obtener más información, consulta Cómo encontrar tu ID de cliente.
customers.quarantinedMessages customers/CUSTOMER_ID/quarantinedMessages/MESSAGE_OWNER:MESSAGE_ID Un mensaje de correo electrónico retenido en cuarentena. MESSAGE_OWNER es la dirección de correo electrónico del propietario del buzón de correo y MESSAGE_ID es el ID de mensaje de Gmail inmutable.
customers.quarantines customers/CUSTOMER_ID/quarantines/QUARANTINE_ID Es una cuarentena que configuraste en la Consola del administrador.
customers.operations customers/CUSTOMER_ID/operations/OPERATION_ID Es una operación de larga duración que hace un seguimiento de una solicitud de liberación o denegación por lotes.

Un QuarantinedMessage contiene uno de los siguientes objetos State:

Estado Descripción
PENDING_TRIAGE El mensaje se retiene en cuarentena y espera la decisión de un administrador.
RELEASED Un administrador liberó el mensaje y Gmail lo entregó.
DENIED Un administrador rechazó el mensaje y Gmail lo descartó.

Métodos

Todas las solicitudes se segmentan para https://mailadminquarantine.googleapis.com/v1.

Método Solicitud HTTP Descripción
customers.quarantinedMessages.list GET /customers/*/quarantinedMessages Muestra los mensajes en cuarentena de los últimos 30 días.
customers.quarantinedMessages.search POST /customers/*/quarantinedMessages:search Busca mensajes en cuarentena con un filtro o una búsqueda de Gmail.
customers.quarantinedMessages.get GET /customers/*/quarantinedMessages/* Obtiene metadatos, contenido analizado o el mensaje RFC 2822 sin procesar.
customers.quarantinedMessages.release POST /customers/*/quarantinedMessages/*:release Libera un solo mensaje para su entrega.
customers.quarantinedMessages.deny POST /customers/*/quarantinedMessages/*:deny Rechaza un solo mensaje.
customers.quarantinedMessages.batchRelease POST /customers/*/quarantinedMessages:batchRelease Libera de forma asíncrona hasta 500 mensajes.
customers.quarantinedMessages.batchDeny POST /customers/*/quarantinedMessages:batchDeny Rechaza de forma asíncrona hasta 500 mensajes.
customers.operations.get GET /customers/*/operations/* Obtiene el estado y los resultados de una operación por lotes.
customers.quarantines.list GET /customers/*/quarantines Enumera las cuarentenas configuradas para el cliente.
customers.quarantines.get GET /customers/*/quarantines/* Obtiene el nombre visible y la descripción de una cuarentena.

Pasos de implementación de alto nivel

  1. Configura la API: Únete al Programa de Versión preliminar para desarrolladores, habilita la API en tu proyecto de Google Cloud, busca tu ID de cliente y otorga el privilegio de administrador requerido.
  2. Autoriza con la delegación de todo el dominio: crea una cuenta de servicio, configura la delegación de todo el dominio con los permisos de la API de Admin Quarantine y obtén un token de acceso que actúe en nombre de un administrador.
  3. Clasifica los mensajes:
    1. Enumera y busca mensajes en cuarentena.
    2. Obtén detalles de los mensajes.
    3. Liberar o rechazar un mensaje, o liberar o rechazar mensajes en lotes.
  4. Mantente dentro de las cuotas de uso.

Registros de auditoría

Cada llamada a la API que lee o cambia los mensajes en cuarentena se registra en los registros de auditoría e investigación de la Consola del administrador, que se atribuyen al administrador como el que se ejecuta la solicitud.

Próximos pasos