Présentation de l'API Mail Admin Quarantine

L'API Mail Admin Quarantine permet aux administrateurs Google Workspace de gérer de manière programmatique les e-mails que Gmail conserve dans une zone de quarantaine d'administration. Les messages sont placés en quarantaine lorsqu'ils correspondent aux règles de conformité, de protection contre la perte de données ou de sécurité que vous configurez dans la console d'administration Google.

Utilisez l'API pour créer des automatisations de sécurité et de conformité, par exemple :

  • Récupérer les messages mis en quarantaine dans une plate-forme SIEM ou SOAR pour les trier.
  • Examiner les en-têtes de message, les extraits de corps de texte et les pièces jointes avant de décider de la manière de traiter un message.
  • Libérer les messages sûrs et refuser ceux qui ne le sont pas, individuellement ou par lots de 500 messages maximum.

Ressources clés

L'API Admin Quarantine expose les ressources suivantes pour un client :

Ressource Nom de la ressource Description
Client customers/CUSTOMER_ID Votre compte Google Workspace. Pour en savoir plus, consultez Localiser votre numéro client.
customers.quarantinedMessages customers/CUSTOMER_ID/quarantinedMessages/MESSAGE_OWNER:MESSAGE_ID E-mail placé en quarantaine. MESSAGE_OWNER est l'adresse e-mail du propriétaire de la boîte aux lettres et MESSAGE_ID est l'ID immuable du message Gmail.
customers.quarantines customers/CUSTOMER_ID/quarantines/QUARANTINE_ID Une quarantaine que vous avez configurée dans la console d'administration.
customers.operations customers/CUSTOMER_ID/operations/OPERATION_ID Opération de longue durée qui suit une demande de libération ou de refus par lot.

Un QuarantinedMessage contient l'un des objets State suivants :

État Description
PENDING_TRIAGE Le message est mis en quarantaine et attend une décision de l'administrateur.
RELEASED Un administrateur a libéré le message et Gmail l'a distribué.
DENIED Un administrateur a refusé le message, et Gmail l'a supprimé.

Méthodes

Toutes les requêtes ciblent https://mailadminquarantine.googleapis.com/v1.

Méthode Requête HTTP Description
customers.quarantinedMessages.list GET /customers/*/quarantinedMessages Liste les messages mis en quarantaine au cours des 30 derniers jours.
customers.quarantinedMessages.search POST /customers/*/quarantinedMessages:search Recherche les messages mis en quarantaine à l'aide d'un filtre ou d'une requête de recherche Gmail.
customers.quarantinedMessages.get GET /customers/*/quarantinedMessages/* Récupère les métadonnées, le contenu analysé ou le message RFC 2822 brut.
customers.quarantinedMessages.release POST /customers/*/quarantinedMessages/*:release Libère un seul message pour distribution.
customers.quarantinedMessages.deny POST /customers/*/quarantinedMessages/*:deny Refuse un seul message.
customers.quarantinedMessages.batchRelease POST /customers/*/quarantinedMessages:batchRelease Libère de manière asynchrone jusqu'à 500 messages.
customers.quarantinedMessages.batchDeny POST /customers/*/quarantinedMessages:batchDeny Refuse de manière asynchrone jusqu'à 500 messages.
customers.operations.get GET /customers/*/operations/* Récupère l'état et les résultats d'une opération par lot.
customers.quarantines.list GET /customers/*/quarantines Répertorie les quarantaines configurées pour le client.
customers.quarantines.get GET /customers/*/quarantines/* Récupère le nom à afficher et la description d'une mise en quarantaine.

Principales étapes d'implémentation

  1. Configurer l'API : rejoignez le programme Preview développeur, activez l'API dans votre projet Google Cloud, recherchez votre numéro client et accordez les droits d'administrateur requis.
  2. Autoriser avec la délégation au niveau du domaine : créez un compte de service, configurez la délégation au niveau du domaine avec les champs d'application de l'API Admin Quarantine et obtenez un jeton d'accès qui emprunte l'identité d'un administrateur.
  3. Messages de tri :
    1. Lister et rechercher des messages mis en quarantaine
    2. Obtenir des informations sur un message
    3. Distribuez ou refusez un message, ou distribuez ou refusez des messages par lots.
  4. Respectez les quotas d'utilisation.

Journaux d'audit

Chaque appel d'API qui lit ou modifie des messages mis en quarantaine est enregistré dans les journaux d'audit et d'investigation de la console d'administration, et attribué à l'administrateur au nom duquel la requête est exécutée.

Étapes suivantes