Avant d'appeler l'API Mail Admin Quarantine, suivez les étapes de cette page pour activer l'API, trouver les identifiants dont chaque requête a besoin et accorder les droits d'administrateur requis dans votre compte Google Workspace.
Prérequis
- Un compte Google Workspace avec la fonctionnalité de quarantaine d'administration. Pour en savoir plus, consultez Configurer et gérer les zones de quarantaine pour les e-mails.
- Un projet Google Cloud. Pour créer un projet, consultez Créer un projet.
- Être membre du programme Preview développeur Google Workspace. Votre projet Cloud doit être inscrit au programme avant de pouvoir appeler l'API Admin Quarantine.
- Accès à la console d'administration Google en tant que super-administrateur, pour accorder des droits d'administrateur et autoriser la délégation au niveau du domaine.
Activer l'API
Activez mailadminquarantine.googleapis.com dans le projet Cloud qui héberge votre intégration.
Console
Dans la console Google Cloud, activez l'API Mail Admin Quarantine.
gcloud
Exécutez la commande suivante en remplaçant PROJECT_ID par l'ID de votre projet Cloud :
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
Trouver votre numéro client
Chaque requête envoyée à l'API Admin Quarantine identifie votre compte Google Workspace avec le nom de ressource customers/CUSTOMER_ID.
Pour trouver votre numéro client :
- Connectez-vous à la console d'administration en tant qu'administrateur.
- Accédez à Compte > Paramètres du compte > Profil.
- Copiez le numéro client.
Si le numéro client commence par C, supprimez C et utilisez la valeur alphanumérique restante dans le nom de la ressource, par exemple customers/01abc23de.
N'utilisez pas votre nom de domaine comme ID client.
Pour en savoir plus, consultez Trouver votre numéro client.
Accorder les droits d'administrateur requis
L'API Admin Quarantine applique les mêmes vérifications des droits d'administrateur que la mise en quarantaine administrative dans la console d'administration. Chaque requête est exécutée au nom d'un administrateur Google Workspace, qui doit disposer de l'un des droits Gmail suivants :
| Visite privilège | Ce qu'il permet de faire |
|---|---|
| Accéder à la zone de quarantaine administrative | Accéder aux messages placés dans toutes les zones de quarantaine et les gérer, y compris ceux placés dans la zone de quarantaine par défaut. |
| Accéder aux zones de quarantaine restreintes | Accès et gestion réservés aux messages qui sont placés dans les zones de quarantaine associées aux groupes dont l'administrateur est membre |
Les super-administrateurs disposent automatiquement de ces droits. Pour les autres administrateurs, attribuez un rôle qui inclut le droit :
- Connectez-vous à la console d'administration en tant que super-administrateur.
- Accédez à Compte > Rôles d'administrateur.
- Sélectionnez un rôle existant ou cliquez sur Créer un rôle.
- Dans l'onglet Droits, accédez à Services > Gmail, puis sélectionnez Accéder à la zone de quarantaine administrative ou Accéder aux zones de quarantaine restreintes.
- Attribuez le rôle au compte administrateur dont votre intégration emprunte l'identité lorsqu'elle appelle l'API.
Pour en savoir plus sur les rôles d'administrateur délégué, consultez Déléguer des droits d'administrateur dans Gmail et Définition des droits d'administrateur.
Si l'administrateur dont l'identité est empruntée ne dispose pas du droit requis, l'API renvoie une erreur 403 PERMISSION_DENIED.