Visão geral da API Mail Admin Quarantine

Com a API Mail Admin Quarantine, os administradores do Google Workspace podem gerenciar de forma programática as mensagens de e-mail que o Gmail mantém em uma quarentena de administrador. As mensagens vão para uma quarentena quando correspondem às regras de compliance, Prevenção contra perda de dados (DLP) ou segurança que você configura no Google Admin Console.

Use a API para criar automações de segurança e compliance, como:

  • Recuperar mensagens em quarentena em uma plataforma SIEM ou SOAR para triagem.
  • Analisar cabeçalhos de mensagens, snippets de corpo e anexos antes de decidir como lidar com uma mensagem.
  • Liberar mensagens seguras e negar as que não são, individualmente ou em lotes de até 500 mensagens.

Recursos principais

A API Admin Quarantine expõe os seguintes recursos em um cliente:

Recurso Nome do recurso Descrição
Cliente customers/CUSTOMER_ID Sua conta do Google Workspace. Para mais detalhes, consulte Encontrar seu ID de cliente.
customers.quarantinedMessages customers/CUSTOMER_ID/quarantinedMessages/MESSAGE_OWNER:MESSAGE_ID Uma mensagem de e-mail mantida em quarentena. MESSAGE_OWNER é o endereço de e-mail do proprietário da caixa de correio, e MESSAGE_ID é o ID imutável da mensagem do Gmail.
customers.quarantines customers/CUSTOMER_ID/quarantines/QUARANTINE_ID Uma quarentena que você configurou no Admin Console.
customers.operations customers/CUSTOMER_ID/operations/OPERATION_ID Uma operação de longa duração que rastreia uma solicitação de liberação ou negação em lote.

Um QuarantinedMessage contém um dos seguintes objetos State:

Estado Descrição
PENDING_TRIAGE A mensagem é mantida em quarentena e aguarda uma decisão do administrador.
RELEASED Um administrador liberou a mensagem, e o Gmail a entregou.
DENIED Um administrador recusou a mensagem, e o Gmail a descartou.

Métodos

Todas as solicitações segmentam https://mailadminquarantine.googleapis.com/v1.

Método Solicitação HTTP Descrição
customers.quarantinedMessages.list GET /customers/*/quarantinedMessages Lista as mensagens em quarentena dos últimos 30 dias.
customers.quarantinedMessages.search POST /customers/*/quarantinedMessages:search Pesquisa mensagens em quarentena usando um filtro ou uma consulta de pesquisa do Gmail.
customers.quarantinedMessages.get GET /customers/*/quarantinedMessages/* Recebe metadados, conteúdo analisado ou a mensagem RFC 2822 bruta.
customers.quarantinedMessages.release POST /customers/*/quarantinedMessages/*:release Libera uma única mensagem para entrega.
customers.quarantinedMessages.deny POST /customers/*/quarantinedMessages/*:deny Nega uma única mensagem.
customers.quarantinedMessages.batchRelease POST /customers/*/quarantinedMessages:batchRelease Libera até 500 mensagens de forma assíncrona.
customers.quarantinedMessages.batchDeny POST /customers/*/quarantinedMessages:batchDeny Nega até 500 mensagens de forma assíncrona.
customers.operations.get GET /customers/*/operations/* Recebe o status e os resultados de uma operação em lote.
customers.quarantines.list GET /customers/*/quarantines Lista as quarentenas configuradas para o cliente.
customers.quarantines.get GET /customers/*/quarantines/* Recebe o nome de exibição e a descrição de uma quarentena.

Etapas de implementação de alto nível

  1. Configurar a API: participe do Programa de prévia para desenvolvedores, ative a API no seu projeto na nuvem do Google Cloud, encontre seu ID de cliente e conceda o privilégio de administrador necessário.
  2. Autorizar com a delegação em todo o domínio: crie uma conta de serviço, configure a delegação em todo o domínio com os escopos da API Admin Quarantine e receba um token de acesso que personifica um administrador.
  3. Mensagens de triagem:
    1. Listar e pesquisar mensagens em quarentena.
    2. Acessar os detalhes de uma mensagem.
    3. Liberar ou recusar uma mensagem ou liberar ou recusar mensagens em lote.
  4. Fique dentro das cotas de uso.

Registro de auditoria

Cada chamada de API que lê ou altera mensagens em quarentena é registrada nos registros de auditoria e investigação do Admin Console, atribuídos ao administrador que executa a solicitação.

Próximas etapas