Ce document contient des informations sur l'autorisation et l'authentification spécifiques à l'API Gmail. Avant de lire ce document, assurez-vous de consulter les informations générales sur l'authentification et l'autorisation dans Google Workspace sur la page 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 habilitations pour définir les informations affichées aux utilisateurs et aux évaluateurs 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 les niveaux d'autorisation. Un champ d'application d'autorisation est une chaîne URI OAuth 2.0 qui contient le nom de l'application Google Workspace, le type de données auxquelles elle accède et le niveau d'accès. Les champs d'application correspondent aux demandes de votre application pour travailler avec les données Google Workspace, y compris les données de compte Google des utilisateurs.
Lors de l'installation de votre application, 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 niveaux d'accès limités et clairement décrits.
L'API Gmail est compatible avec les champs d'application suivants :
| Code du champ d'application | Description | Utilisation |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Gérer les brouillons et envoyer des e-mails lors de vos interactions avec le module complémentaire. | Non sensible |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Consulter 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 votre e-mail 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 |
Consulter 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 des messages uniquement. Aucun droit de lecture ni 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 (aucune opération 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érer et importer des messages uniquement. | 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 fils de discussion et des messages, en contournant la corbeille. | Limité |
https://www.googleapis.com/auth/gmail.metadata |
Lire les métadonnées des ressources, y compris les libellés, l'historique et les en-têtes des e-mails, mais pas le corps des messages ni les pièces jointes. | Limité |
https://www.googleapis.com/auth/gmail.settings.basic |
Gérez les paramètres de base de votre messagerie. | Limité |
https://www.googleapis.com/auth/gmail.settings.sharing |
Gérez les paramètres de messagerie particulièrement sensibles, y compris les règles de transfert et les alias.
Remarque : Les opérations protégées par ce champ d'application sont réservées à un usage administratif. Elles ne sont disponibles que pour les clients Google Workspace qui utilisent 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 fils de discussion et des messages. Cette autorisation ne doit être demandée que si votre application doit supprimer immédiatement et définitivement des fils de discussion et des messages, en ignorant la corbeille. Toutes les autres actions peuvent être effectuées avec des autorisations moins permissives. | Limité |
La colonne "Utilisation" du tableau ci-dessus indique la sensibilité de chaque autorisation, selon les définitions suivantes :
Non sensibles : ces niveaux d'accès offrent la plus petite sphère d'accès à l'autorisation et ne nécessitent qu'une validation de base de l'application. Pour en savoir plus sur cette exigence, consultez Étapes à suivre pour préparer la validation.
Sensibles : ces niveaux d'accès permettent d'accéder aux données utilisateur Google et nécessitent une procédure de validation des niveaux d'accès sensibles. Pour en savoir plus sur cette exigence, consultez le Règlement sur les données utilisateur dans les services d'API Google. Ces niveaux d'accès ne nécessitent pas d'évaluation de sécurité.
Restreint : ces niveaux d'accès offrent un large accès aux données utilisateur Google et nécessitent de suivre une procédure de validation des niveaux d'accès restreints. Pour en savoir plus sur cette exigence, consultez les Règles relatives aux données utilisateur dans les services d'API Google et les Exigences supplémentaires pour les champs d'application d'API spécifiques. Si vous stockez (ou transmettez) des données à portée restreinte sur des serveurs, vous devez passer une évaluation de sécurité.
Vous trouverez des informations supplémentaires régissant votre utilisation des API Gmail et votre accès à celles-ci lorsque vous demandez à accéder aux données utilisateur dans le Règlement sur les données utilisateur et le programme pour les développeurs des services d'API Gmail.
Si votre application nécessite 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 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 passe par la procédure de validation OAuth de Google. Consultez les questions fréquentes sur la validation OAuth pour savoir quand votre application doit être validée et quel type de validation est requis. Consultez également le Règlement sur les données utilisateur dans les services d'API Google.