Ce document contient des informations d'autorisation et d'authentification spécifiques à l'API Gmail. Avant de lire ce document, veillez à lire les informations générales d'authentification et d'autorisation de Google Workspace dans la section En savoir plus sur l'authentification et l'autorisation.
Configurer OAuth 2.0 pour l'autorisation
Configurez l'écran de consentement OAuth et choisissez des champs d'application pour définir les informations à présenter aux utilisateurs et aux examinateurs d'applications, et enregistrez votre application pour pouvoir la publier ultérieurement.
Champs d'application de l'API Gmail
Pour définir le niveau d'accès accordé à votre application, vous devez identifier et déclarer des champs d'application d'autorisation. Un champ d'application d'autorisation est une chaîne d'URI OAuth 2.0 contenant le nom de l'application Google Workspace, le type de données auquel elle accède et le niveau d'accès. Les champs d'application correspondent aux demandes d'utilisation des données Google Workspace par votre application, y compris les données des comptes Google des utilisateurs.
Lorsque votre application est installée, l'utilisateur est invité à valider les champs d'application utilisés par l'application. En règle générale, vous devez choisir le champ d'application le plus précis possible et éviter de demander des champs d'application dont votre application n'a pas besoin. Les utilisateurs accordent plus facilement l'accès à des champs d'application limités et clairement décrits.
L'API Gmail accepte les champs d'application suivants:
| Code du champ d'application | Description | Utilisation |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Gérez les brouillons et envoyez des e-mails lorsque vous interagissez avec le module complémentaire. | Non sensible |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Consultez vos e-mails lorsque vous interagissez avec le module complémentaire. | Non sensible |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Afficher les métadonnées de vos e-mails lorsque le module complémentaire est en cours d'exécution. | Contenu à caractère sensible |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Consultez vos e-mails lorsque le module complémentaire est en cours d'exécution. | Contenu à caractère sensible |
https://www.googleapis.com/auth/gmail.labels |
Créer, lire, mettre à jour et supprimer des libellés uniquement. | Non sensible |
https://www.googleapis.com/auth/gmail.send |
Envoyer uniquement des messages. Aucun droit de lecture ou de modification sur la boîte aux lettres. | Contenu à caractère sensible |
https://www.googleapis.com/auth/gmail.readonly |
Lecture de toutes les ressources et de leurs métadonnées (pas d'opérations d'écriture). | Limité |
https://www.googleapis.com/auth/gmail.compose |
Créer, lire, mettre à jour et supprimer des brouillons envoyer des messages et des brouillons ; | Limité |
https://www.googleapis.com/auth/gmail.insert |
Insérez et importez uniquement des messages. | Limité |
https://www.googleapis.com/auth/gmail.modify |
Toutes les opérations de lecture/écriture, à l'exception de la suppression immédiate et définitive des threads et des messages, en contournant la corbeille | Limité |
https://www.googleapis.com/auth/gmail.metadata |
Permet de lire les métadonnées des ressources, y compris les libellés, les enregistrements d'historique et les en-têtes d'e-mails, mais pas le corps du message ni les pièces jointes. | Limité |
https://www.googleapis.com/auth/gmail.settings.basic |
gérer les paramètres de base de la messagerie ; | Limité |
https://www.googleapis.com/auth/gmail.settings.sharing |
Gérez les paramètres de messagerie sensibles, y compris les règles de transfert et les alias.
Remarque:Les opérations protégées par ce champ d'application sont limitées à un usage administratif. Ils ne sont disponibles que pour les clients Google Workspace utilisant un compte de service avec délégation au niveau du domaine. |
Limité |
https://mail.google.com/ |
Accès complet aux boîtes aux lettres du compte, y compris la suppression définitive des threads et des messages. Ce champ d'application ne doit être demandé que si votre application doit supprimer immédiatement et définitivement des threads et des messages, en contournant la corbeille. Toutes les autres actions peuvent être effectuées avec des champs d'application moins permissifs. | Limité |
La colonne "Utilisation" du tableau ci-dessus indique la sensibilité de chaque champ d'application, selon les définitions suivantes:
Non sensible : ces champs d'application fournissent la plus petite sphère d'autorisation et ne nécessitent que la validation de base des applications. Pour en savoir plus sur cette exigence, consultez la section Étapes de préparation de la validation.
Sensible : ces champs d'application permettent d'accéder aux données utilisateur Google et nécessitent un processus de validation des champs d'application sensibles. Pour en savoir plus sur cette exigence, consultez Services d'API Google: Règle sur les données utilisateur. Ces champs d'application ne nécessitent pas d'évaluation de sécurité.
Restreint : ces champs d'application fournissent un large accès aux données utilisateur Google et vous obligent à suivre une procédure de validation des champs d'application restreints. Pour en savoir plus sur cette exigence, consultez les pages Services d'API Google: Règles sur les données utilisateur et Exigences supplémentaires pour les champs d'application d'API spécifiques. Si vous stockez (ou transmettez) des données de champ d'application restreint sur des serveurs, vous devez effectuer une évaluation de la sécurité.
Vous trouverez des informations supplémentaires régissant votre utilisation et votre accès aux API Gmail lorsque vous demandez l'accès aux données utilisateur dans Données utilisateur et Règlement pour les développeurs des services d'API Gmail.
Si votre application a besoin d'accéder à d'autres API Google, vous pouvez également ajouter ces champs d'application. Pour en savoir plus sur les champs d'application des API Google, consultez la page Utiliser OAuth 2.0 pour accéder aux API Google.
Validation OAuth
L'utilisation de certains champs d'application OAuth sensibles peut nécessiter que votre application soit soumise au processus de validation OAuth de Google. Consultez les questions fréquentes sur la validation OAuth pour déterminer quand votre application doit être validée et quel type de validation est requis. Consultez également les Règles relatives aux données utilisateur dans les services d'API Google.