Utiliser OAuth 2.0 pour accéder aux API Google

Les API Google utilisent le protocole OAuth 2.0 pour l'authentification et l'autorisation. Google accepte les scénarios courants OAuth 2.0, tels que ceux relatifs au serveur Web, aux applications installées et aux applications côté client.

Pour commencer, obtenez des identifiants client OAuth 2.0 auprès de Google API Console. Votre application cliente demande ensuite un jeton d'accès au serveur d'autorisation Google, extrait le jeton de la réponse et l'envoie à l'API Google à laquelle vous souhaitez accéder. Pour obtenir une démonstration interactive de l'utilisation du protocole OAuth 2.0 avec Google (et de l'utilisation de vos propres identifiants client), testez OAuth 2.0 Playground.

Cette page présente les scénarios d'autorisation OAuth 2.0 acceptés par Google et fournit des liens vers des contenus plus détaillés. Pour en savoir plus sur l'utilisation d'OAuth 2.0 pour l'authentification, consultez OpenID Connect.

Procédure générale

Toutes les applications suivent un modèle de base lorsqu'elles accèdent à une API Google à l'aide d'OAuth 2.0. De manière générale, vous devez suivre cinq étapes:

1. Obtenez des identifiants OAuth 2.0 à partir de l' Google API Console.

Accédez à Google API Console pour obtenir des identifiants OAuth 2.0 tels qu'un ID client et un code secret connus à la fois par Google et votre application. L'ensemble des valeurs varie en fonction du type d'application que vous créez. Par exemple, une application JavaScript ne nécessite pas de secret, mais une application de serveur Web en a besoin.

Vous devez créer un client OAuth adapté à la plate-forme sur laquelle votre application s'exécute, par exemple:

2. Obtenez un jeton d'accès auprès du serveur d'autorisation Google.

Avant que votre application puisse accéder à des données privées à l'aide d'une API Google, elle doit obtenir un jeton d'accès qui lui permet d'accéder à cette API. Un seul jeton d'accès peut accorder différents niveaux d'accès à plusieurs API. Un paramètre variable appelé scope contrôle l'ensemble de ressources et d'opérations autorisées par un jeton d'accès. Lors de la requête de jeton d'accès, votre application envoie une ou plusieurs valeurs dans le paramètre scope.

Il existe plusieurs façons d'effectuer cette requête, et elles varient en fonction du type d'application que vous créez. Par exemple, une application JavaScript peut demander un jeton d'accès à l'aide d'une redirection de navigateur vers Google, tandis qu'une application installée sur un appareil sans navigateur utilise des requêtes de service Web.

Certaines requêtes nécessitent une étape d'authentification au cours de laquelle l'utilisateur se connecte avec son compte Google. Une fois connecté, l'utilisateur est invité à accorder une ou plusieurs des autorisations demandées par votre application. Ce processus est appelé consentement de l'utilisateur.

Si l'utilisateur accorde au moins une autorisation, le serveur d'autorisation Google envoie à votre application un jeton d'accès (ou un code d'autorisation que votre application peut utiliser pour obtenir un jeton d'accès) et une liste des champs d'application de l'accès accordé par ce jeton. Si l'utilisateur n'accorde pas l'autorisation, le serveur renvoie une erreur.

Il est généralement recommandé de demander des portées de manière incrémentielle, au moment où l'accès est requis, plutôt que d'emblée. Par exemple, une application qui souhaite permettre d'enregistrer un événement dans un agenda ne doit pas demander l'accès à Google Agenda tant que l'utilisateur n'a pas appuyé sur le bouton "Ajouter à Agenda". Consultez la section Autorisation incrémentielle.

3. Examinez les niveaux d'accès accordés par l'utilisateur.

Comparez les champs d'application inclus dans la réponse du jeton d'accès à ceux requis pour accéder aux fonctionnalités de votre application qui dépendent de l'accès à une API Google associée. Désactivez les fonctionnalités de votre application qui ne peuvent pas fonctionner sans accès à l'API associée.

Le champ d'application inclus dans votre demande peut ne pas correspondre à celui inclus dans votre réponse, même si l'utilisateur a accordé tous les champs d'application demandés. Reportez-vous à la documentation de chaque API Google pour connaître les portées requises pour l'accès. Une API peut mapper plusieurs valeurs de chaîne de champ d'application sur un seul champ d'application d'accès, en renvoyant la même chaîne de champ d'application pour toutes les valeurs autorisées dans la requête. Exemple: l'API Google People peut renvoyer une portée de https://www.googleapis.com/auth/contacts lorsqu'une application a demandé à un utilisateur d'autoriser une portée de https://www.google.com/m8/feeds/. La méthode people.updateContact de l'API Google People nécessite une portée de https://www.googleapis.com/auth/contacts accordée.

4. Envoyer le jeton d'accès à une API

Une fois qu'une application a obtenu un jeton d'accès, elle l'envoie à une API Google dans un en-tête de requête d'autorisation HTTP. Il est possible d'envoyer des jetons en tant que paramètres de chaîne de requête d'URI, mais nous vous le déconseillons, car les paramètres d'URI peuvent se retrouver dans des fichiers journaux qui ne sont pas entièrement sécurisés. En outre, il est recommandé d'éviter de créer des noms de paramètres d'URI inutiles.

Les jetons d'accès ne sont valides que pour l'ensemble d'opérations et de ressources décrites dans le scope de la requête de jeton. Par exemple, si un jeton d'accès est émis pour l'API Google Agenda, il n'accorde pas d'accès à l'API Google Contacts. Vous pouvez toutefois envoyer ce jeton d'accès à l'API Google Agenda plusieurs fois pour des opérations similaires.

5. Actualisez le jeton d'accès, si nécessaire.

Les jetons d'accès ont une durée de vie limitée. Si votre application a besoin d'accéder à une API Google au-delà de la durée de vie d'un seul jeton d'accès, elle peut obtenir un jeton d'actualisation. Un jeton d'actualisation permet à votre application d'obtenir de nouveaux jetons d'accès.

Scénarios

Applications de serveur Web

Le point de terminaison Google OAuth 2.0 est compatible avec les applications de serveur Web qui utilisent des langages et des frameworks tels que PHP, Java, Go, Python, Ruby et ASP.NET.

La séquence d'autorisation commence lorsque votre application redirige un navigateur vers une URL Google. L'URL inclut des paramètres de requête qui indiquent le type d'accès demandé. Google gère l'authentification, la sélection de la session et le consentement de l'utilisateur. Le résultat est un code d'autorisation, que l'application peut échanger contre un jeton d'accès et un jeton d'actualisation.

L'application doit stocker le jeton d'actualisation pour une utilisation ultérieure et utiliser le jeton d'accès pour accéder à une API Google. Une fois le jeton d'accès expiré, l'application utilise le jeton d'actualisation pour en obtenir un nouveau.

Votre application envoie une requête de jeton au serveur d'autorisation Google, reçoit un code d'autorisation, échange le code contre un jeton et utilise le jeton pour appeler un point de terminaison d'API Google.

Pour en savoir plus, consultez l'article Utiliser OAuth 2.0 pour les applications de serveur Web.

Applications installées

Le point de terminaison Google OAuth 2.0 est compatible avec les applications installées sur des appareils tels que des ordinateurs, des appareils mobiles et des tablettes. Lorsque vous créez un ID client via Google API Console, indiquez qu'il s'agit d'une application installée, puis sélectionnez Android, application Chrome, iOS, plate-forme Windows universelle (UWP) ou application de bureau comme type d'application.

Le processus génère un ID client et, dans certains cas, un code secret du client, que vous incorporez au code source de votre application. (Dans ce contexte, le code secret du client n'est évidemment pas traité comme un secret.)

La séquence d'autorisation commence lorsque votre application redirige un navigateur vers une URL Google. L'URL inclut des paramètres de requête qui indiquent le type d'accès demandé. Google gère l'authentification, la sélection de la session et le consentement de l'utilisateur. Le résultat est un code d'autorisation, que l'application peut échanger contre un jeton d'accès et un jeton d'actualisation.

L'application doit stocker le jeton d'actualisation pour une utilisation ultérieure et utiliser le jeton d'accès pour accéder à une API Google. Une fois le jeton d'accès expiré, l'application utilise le jeton d'actualisation pour en obtenir un nouveau.

Votre application envoie une requête de jeton au serveur d'autorisation Google, reçoit un code d'autorisation, échange le code contre un jeton et utilise le jeton pour appeler un point de terminaison d'API Google.

Pour en savoir plus, consultez Utiliser OAuth 2.0 pour les applications installées.

Applications côté client (JavaScript)

Le point de terminaison Google OAuth 2.0 est compatible avec les applications JavaScript exécutées dans un navigateur.

La séquence d'autorisation commence lorsque votre application redirige un navigateur vers une URL Google. L'URL inclut des paramètres de requête qui indiquent le type d'accès demandé. Google gère l'authentification des utilisateurs, la sélection des sessions et le consentement de l'utilisateur.

Le résultat est un jeton d'accès, que le client doit valider avant de l'inclure dans une requête d'API Google. Lorsque le jeton expire, l'application répète le processus.

Votre application JavaScript envoie une requête de jeton au serveur d'autorisation Google, reçoit un jeton, le valide et l'utilise pour appeler un point de terminaison d'API Google.

Pour en savoir plus, consultez Utiliser OAuth 2.0 pour les applications côté client.

Applications sur des périphériques à saisie limitée

Le point de terminaison Google OAuth 2.0 est compatible avec les applications qui s'exécutent sur des périphériques à entrée limitée tels que les consoles de jeu, les caméscopes et les imprimantes.

La séquence d'autorisation commence par l'application qui envoie une requête de service Web à une URL Google pour obtenir un code d'autorisation. La réponse contient plusieurs paramètres, y compris une URL et un code que l'application affiche à l'utilisateur.

L'utilisateur obtient l'URL et le code de l'appareil, puis passe à un autre appareil ou ordinateur doté de fonctionnalités de saisie plus riches. L'utilisateur lance un navigateur, accède à l'URL spécifiée, se connecte et saisit le code.

Pendant ce temps, l'application interroge une URL Google à un intervalle spécifié. Une fois que l'utilisateur a approuvé l'accès, la réponse du serveur Google contient un jeton d'accès et un jeton d'actualisation. L'application doit stocker le jeton d'actualisation pour une utilisation ultérieure et utiliser le jeton d'accès pour accéder à une API Google. Une fois le jeton d'accès expiré, l'application utilise le jeton d'actualisation pour en obtenir un nouveau.

L'utilisateur se connecte sur un appareil distinct doté d'un navigateur

Pour en savoir plus, consultez Utiliser OAuth 2.0 pour les appareils.

Comptes de service

Les API Google telles que l'API Prediction et Google Cloud Storage peuvent agir au nom de votre application sans accéder aux informations utilisateur. Dans ce cas, votre application doit prouver son identité à l'API, mais aucun consentement de l'utilisateur n'est nécessaire. De même, dans les scénarios d'entreprise, votre application peut demander un accès délégué à certaines ressources.

Pour ces types d'interactions de serveur à serveur, vous avez besoin d'un compte de service, qui appartient à votre application et non à un utilisateur final individuel. Votre application appelle les API Google pour le compte de service, et le consentement de l'utilisateur n'est pas requis. (Dans les scénarios sans compte de service, votre application appelle les API Google pour le compte des utilisateurs finaux, et le consentement de l'utilisateur est parfois requis.)

Les identifiants d'un compte de service, que vous obtenez auprès de Google API Console, incluent une adresse e-mail générée unique, un ID client et au moins une paire de clés publique/privée. Vous utilisez l'ID client et une clé privée pour créer un jeton JWT signé et créer une requête de jeton d'accès au format approprié. Votre application envoie ensuite la requête de jeton au serveur d'autorisation Google OAuth 2.0, qui renvoie un jeton d'accès. L'application utilise le jeton pour accéder à une API Google. Lorsque le jeton expire, l'application répète le processus.

Votre application serveur utilise un jeton JWT pour demander un jeton au serveur d'autorisation Google, puis utilise ce jeton pour appeler un point de terminaison d'API Google. Aucun utilisateur final n'est impliqué.

Pour en savoir plus, consultez la documentation sur les comptes de service.

Taille du jeton

La taille des jetons peut varier, jusqu'aux limites suivantes:

  • Codes d'autorisation: 256 octets
  • Jetons d'accès: 2 048 octets
  • Jetons d'actualisation: 512 octets

Les jetons d'accès renvoyés par l' API Security Token Service de Google Cloud sont structurés de la même manière que les jetons d'accès OAuth 2.0 de l'API Google, mais présentent des limites de taille de jeton différentes. Pour en savoir plus, consultez la documentation de l'API.

Google se réserve le droit de modifier la taille des jetons dans ces limites. Votre application doit donc prendre en charge les tailles de jetons variables en conséquence.

Expiration du jeton d'actualisation

Vous devez écrire votre code pour anticiper la possibilité qu'un jeton d'actualisation accordé ne fonctionne plus. Un jeton d'actualisation peut cesser de fonctionner pour l'une des raisons suivantes:

Un projet Google Cloud Platform avec un écran de consentement OAuth configuré pour un type d'utilisateur externe et un état de publication de "Test" reçoit un jeton d'actualisation qui expire dans sept jours, sauf si les seuls champs OAuth demandés sont un sous-ensemble du nom, de l'adresse e-mail et du profil utilisateur (via les champs userinfo.email, userinfo.profile, openid ou leurs équivalents OpenID Connect).

Il existe actuellement une limite de 100 jetons d'actualisation par compte Google et par ID client OAuth 2.0. Si la limite est atteinte et que vous créez un autre jeton d'actualisation, l'ancien jeton d'actualisation est automatiquement révoqué sans avertissement préalable. Cette limite ne s'applique pas aux comptes de service.

Le nombre total de jetons d'actualisation qu'un compte utilisateur ou un compte de service peut avoir pour tous les clients est également limité. La plupart des utilisateurs normaux ne dépasseront pas cette limite, mais le compte d'un développeur utilisé pour tester une implémentation peut le faire.

Si vous devez autoriser plusieurs programmes, machines ou appareils, vous pouvez limiter le nombre de clients que vous autorisez par compte Google à 15 ou 20. Si vous êtes un administrateur Google Workspace, vous pouvez créer des utilisateurs supplémentaires disposant de droits d'administrateur et les utiliser pour autoriser certains clients.

Gérer les règles de contrôle des sessions pour les organisations Google Cloud Platform (GCP)

Les administrateurs d'organisations GCP peuvent nécessiter une réauthentification fréquente des utilisateurs lorsqu'ils accèdent aux ressources GCP, à l'aide de la fonctionnalité de contrôle de session Google Cloud. Cette règle affecte l'accès à la Google Cloud Console, au SDK Google Cloud (également appelé CLI gcloud) et à toute application OAuth tierce nécessitant la portée Cloud Platform. Si une règle de contrôle de session est en place pour un utilisateur, à l'expiration de la durée de la session, vos appels d'API généreront une erreur semblable à celle qui se produirait si le jeton d'actualisation était révoqué. L'appel échouera avec un type d'erreur invalid_grant. Le champ error_subtype peut être utilisé pour distinguer un jeton révoqué d'un échec dû à une règle de contrôle de session (par exemple, "error_subtype": "invalid_rapt"). Étant donné que la durée de la session peut être très limitée (entre une heure et 24 heures), ce scénario doit être géré correctement en redémarrant une session d'authentification.

De même, vous ne devez pas utiliser ni encourager l'utilisation d'identifiants utilisateur pour le déploiement de serveur à serveur. Si des identifiants utilisateur sont déployés sur un serveur pour des tâches ou des opérations de longue durée et qu'un client applique des règles de contrôle de session à ces utilisateurs, l'application serveur échouera, car il n'y aura aucun moyen de réauthentifier l'utilisateur lorsque la durée de la session arrivera à expiration.

Pour savoir comment aider vos clients à déployer cette fonctionnalité, consultez cet article d'aide destiné aux administrateurs.

Bibliothèques clientes

Les bibliothèques clientes suivantes s'intègrent à des frameworks populaires, ce qui simplifie l'implémentation d'OAuth 2.0. D'autres fonctionnalités seront ajoutées aux bibliothèques au fil du temps.