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 OAuth 2.0 courants, tels que ceux pour les applications de serveur Web, côté client, installées et sur les périphériques d'entrée limitée.

Pour commencer, obtenez les identifiants client OAuth 2.0 à partir de Google API Console. Ensuite, votre application cliente demande un jeton d'accès au serveur d'autorisation Google, extrait un jeton de la réponse et l'envoie à l'API Google à laquelle vous souhaitez accéder. Pour voir une démonstration interactive de l'utilisation d'OAuth 2.0 avec Google (y compris la possibilité d'utiliser vos propres identifiants client), testez OAuth 2.0 Playground.

Cette page présente les scénarios d'autorisation OAuth 2.0 compatibles avec Google et fournit des liens vers des contenus plus détaillés. Pour plus d'informations sur l'utilisation du protocole OAuth 2.0 pour l'authentification, consultez la page OpenID Connect.

Procédure générale

Toutes les applications suivent un schéma de base pour accéder à une API Google via OAuth 2.0. De manière générale, vous suivez cinq étapes:

1. Obtenez les identifiants OAuth 2.0 à partir de Google API Console.

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

Vous devez créer un client OAuth adapté à la plate-forme sur laquelle votre application sera exécutée, par exemple:

2. Procurez-vous un jeton d'accès auprès du serveur d'autorisation Google.

Pour 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 accorde l'accès à cette API. Un même jeton d'accès peut accorder différents degrés d'accès à plusieurs API. Un paramètre de variable appelé scope contrôle l'ensemble des ressources et des 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'envoyer cette requête, qui 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 services 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é à indiquer s'il souhaite accorder une ou plusieurs 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) ainsi qu'une liste des champs d'application d'accès accordés 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 champs d'application de manière incrémentielle, au moment où l'accès est requis, plutôt qu'à l'avance. Par exemple, une application qui souhaite 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 à l'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 en fonction de l'accès à une API Google associée. Désactivez toutes 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 requête 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 champs d'application requis pour l'accès. Une API peut mapper plusieurs valeurs de chaîne de champ d'application avec un seul champ d'application, 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 un champ d'application de https://www.googleapis.com/auth/contacts lorsqu'une application a demandé à un utilisateur d'autoriser un champ d'application de https://www.google.com/m8/feeds/. La méthode people.updateContact de l'API Google People nécessite un champ d'application autorisé de https://www.googleapis.com/auth/contacts.

4. Envoyez 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. Vous pouvez 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 complètement sécurisés. En outre, il est recommandé d'éviter de créer des noms de paramètres URI inutiles.

Les jetons d'accès ne sont valides que pour l'ensemble des opérations et des 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 Calendar, il n'accorde pas l'accès à l'API Google Contacts. Toutefois, vous pouvez 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 jeton d'accès unique, elle peut obtenir un jeton d'actualisation. Un jeton d'actualisation permet à votre application d'obtenir de nouveaux jetons d'accès.

Exemple

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, Python, Ruby et ASP.NET.

La séquence d'autorisation commence lorsque votre application redirige un navigateur vers une URL Google. Cette URL inclut des paramètres de requête qui indiquent le type d'accès demandé. Google gère l'authentification de l'utilisateur, la sélection des sessions 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 l'utiliser 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, l'échange contre un jeton et utilise le jeton pour appeler un point de terminaison de l'API Google.

Pour en savoir plus, consultez la page 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 les ordinateurs, les appareils mobiles et les 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 intégrez au code source de votre application. (Dans ce contexte, le code secret du client n'est évidemment pas considéré comme un code secret.)

La séquence d'autorisation commence lorsque votre application redirige un navigateur vers une URL Google. Cette URL inclut des paramètres de requête qui indiquent le type d'accès demandé. Google gère l'authentification de l'utilisateur, la sélection des sessions 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 l'utiliser 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, l'échange contre un jeton et utilise le jeton pour appeler un point de terminaison de l'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 qui s'exécutent dans un navigateur.

La séquence d'autorisation commence lorsque votre application redirige un navigateur vers une URL Google. Cette URL inclut des paramètres de requête qui indiquent le type d'accès demandé. Google gère l'authentification de l'utilisateur, 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 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 de l'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 d'entrée limités tels que des consoles de jeu, des caméras vidéo et des imprimantes.

La séquence d'autorisation commence lorsque l'application 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 présente à l'utilisateur.

L'utilisateur obtient l'URL et le code de l'appareil, puis passe à un autre appareil ou ordinateur doté de fonctionnalités d'entrée 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 l'utiliser 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 des utilisateurs. Dans ces situations, votre application doit prouver sa propre 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 l'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 au nom du 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, ce qui nécessite parfois le consentement de l'utilisateur.

Les identifiants d'un compte de service, que vous obtenez à partir 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 utiliserez l'ID client et une clé privée pour créer un jeton JWT signé et élaborer 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 ce jeton pour accéder à une API Google. Lorsque le jeton expire, l'application répète le processus.

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

Pour en savoir plus, consultez la documentation relative aux comptes de service.

Taille du jeton

La taille des jetons peut varier, dans les limites suivantes:

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

La structure des jetons d'accès renvoyés par l' API Security Token Service de Google Cloud est semblable à celle des jetons d'accès OAuth 2.0 de l'API Google, mais leurs limites sont différentes. Pour en savoir plus, consultez la documentation de l'API.

Google se réserve le droit de modifier la taille du jeton dans ces limites. Votre application doit accepter des tailles de jeton 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 dont l'écran de consentement OAuth est configuré pour un type d'utilisateur externe et dont l'état de publication est "Test" reçoit un jeton d'actualisation qui expire dans sept jours, sauf si les seuls champs d'application OAuth demandés sont un sous-ensemble de nom, d'adresse e-mail et de profil utilisateur (via les champs d'application 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, la création d'un autre jeton d'actualisation invalide automatiquement le jeton d'actualisation le plus ancien sans avertissement. Cette limite ne s'applique pas aux comptes de service.

La limite du nombre total de jetons d'actualisation qu'un compte utilisateur ou un compte de service peut avoir pour tous les clients est également plus élevée. La plupart des utilisateurs normaux ne dépasseront pas cette limite, contrairement à un compte de développeur utilisé pour tester une implémentation.

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

Traiter les stratégies de contrôle de session pour les organisations Google Cloud Platform (GCP)

Les administrateurs d'organisations GCP peuvent exiger 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 a un impact sur l'accès à la console Google Cloud, au SDK Google Cloud (également appelé gcloud CLI) et à toute application OAuth tierce nécessitant le champ d'application de Cloud Platform. Si un utilisateur a mis en place une règle de contrôle de session, à l'expiration de la durée de session, vos appels d'API généreront une erreur semblable à ce qui se passerait si le jeton d'actualisation était révoqué : l'appel échouera avec le type d'erreur invalid_grant. Le champ error_subtype peut être utilisé pour distinguer un jeton révoqué et un échec dû à une règle de contrôle de session (par exemple, "error_subtype": "invalid_rapt"). La durée de session peut être très limitée (entre 4 heures et 2 heures).

De même, vous ne devez pas utiliser d'identifiants utilisateur pour le déploiement de serveur à serveur, ni encourager leur utilisation. 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 à l'expiration de la session.

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 aux frameworks courants, ce qui facilite l'implémentation d'OAuth 2.0. D'autres fonctionnalités seront ajoutées à ces bibliothèques au fil du temps.