Cette page a été traduite par l'API Cloud Translation.

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 côté client, aux applications installées et aux applications pour appareils à entrée limitée.

Pour commencer, obtenez des identifiants client OAuth 2.0 à partir 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 d'OAuth 2.0 avec Google (y compris l'option 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 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 schéma 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 les identifiants OAuth 2.0 à partir de Google API Console.

Accédez à Google API Console pour obtenir des identifiants OAuth 2.0, tels qu'un ID client et un code secret client, connus à la fois de Google et de 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 code secret, contrairement à une application de serveur Web.

Vous devez créer un client OAuth adapté à la plate-forme sur laquelle votre application s'exécutera. Par exemple :

code Pour les applications Web JavaScript ou côté serveur, utilisez le type de client "web". N'utilisez pas ce type de client pour d'autres applications, comme les applications natives ou mobiles.
Pour les applications Android, utilisez le type de client "Android".
Pour les applications iOS et macOS, utilisez le type de client "iOS".
Pour les applications de la plate-forme Windows universelle, utilisez le type de client "Plate-forme Windows universelle".
tv Pour les appareils à saisie limitée, tels que les téléviseurs ou les appareils intégrés, utilisez le type de client "TV et appareils à saisie limitée".
host Pour les interactions de serveur à serveur, utilisez des comptes de service.

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 accorde l'accès à cette API. Un même jeton d'accès peut accorder différents niveaux d'accès à plusieurs API. Un paramètre de variable appelé scope contrôle l'ensemble des ressources et des opérations qu'un jeton d'accès autorise. Lors de la demande de jeton d'accès, votre application envoie une ou plusieurs valeurs dans le paramètre scope.

Il existe plusieurs façons de faire cette demande, 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 du 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 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 niveaux 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 les niveaux d'accès de manière incrémentielle, au moment où l'accès est requis, plutôt qu'à l'avance. Par exemple, une application qui souhaite permettre l'enregistrement d'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 Autorisation incrémentielle.

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

Comparez les niveaux d'accès 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 toutes les fonctionnalités de votre application qui ne peuvent pas fonctionner sans accès à l'API associée.

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

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. Il est possible d'envoyer des jetons en tant que paramètres de chaîne de requête URI, mais nous ne le recommandons pas, car les paramètres URI peuvent se retrouver dans des fichiers journaux qui ne sont pas entièrement sécurisés. De plus, 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 demande de jeton. Par exemple, si un jeton d'accès est émis pour l'API Google Agenda, 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.

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. 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 de 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 se servir du 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 demande 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 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, spécifiez qu'il s'agit d'une application installée, puis sélectionnez "Application Android", "Application Chrome", "Application iOS", "Plate-forme Windows universelle (UWP)" ou "Application de bureau" comme type d'application.

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

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.

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 JS envoie une demande 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 appareils à saisie limitée, tels que les consoles de jeu, les caméras vidéo et les 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 affiche à l'utilisateur.

L'utilisateur obtient l'URL et le code de l'appareil, puis passe à un autre appareil ou ordinateur doté de capacité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 se servir du 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 autre appareil 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 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 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 est un compte appartenant à 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, et le consentement de l'utilisateur est parfois requis.)

Les identifiants d'un compte de service, que vous obtenez à partir de Google API Console, incluent une adresse e-mail générée qui est unique, un ID client et au moins une paire de clés publiques/privées. Vous utilisez l'ID client et une clé privée pour créer un jeton JWT signé et construire une demande de jeton d'accès au format approprié. Votre application envoie ensuite la demande 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 le 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, dans les limites suivantes :

code Codes d'autorisation
256 octets
contextual_token Jetons d'accès
2 048 octets
restore_page 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 des API Google, mais leurs limites de taille sont 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.

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 :

shield_locked L'utilisateur a révoqué l'accès de votre application.
Le jeton d'actualisation n'a pas été utilisé depuis six mois.
L'utilisateur a modifié son mot de passe et le jeton d'actualisation contient des autorisations Gmail.
Le compte utilisateur a dépassé le nombre maximal de jetons d'actualisation (actifs) accordés.
L'utilisateur a accordé un accès limité dans le temps à votre application, et cet accès a expiré.
Si un administrateur a défini l'un des services demandés dans les champs d'application de votre application sur "Restreint" (l'erreur est admin_policy_enforced).
cloud_lock Pour les API Google Cloud Platform, la durée de session définie par l'administrateur a peut-être été dépassée.

Un projet Google Cloud Platform avec un écran de consentement OAuth configuré pour un type d'utilisateur externe et un état de publication "En test" reçoit un jeton d'actualisation expirant au bout de sept jours, sauf si les seuls périmètres OAuth demandés sont un sous-ensemble du nom, de l'adresse e-mail et du profil utilisateur (via les périmètres 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.

Une limite plus élevée s'applique également au nombre total de jetons d'actualisation qu'un compte utilisateur ou un compte de service peut avoir sur tous les clients. La plupart des utilisateurs normaux ne dépasseront pas cette limite, mais un compte de 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 des 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é CLI gcloud) et à toute application OAuth tierce nécessitant le champ d'application Cloud Platform. Si une règle de contrôle de session est en place pour un utilisateur, vos appels d'API généreront une erreur à l'expiration de la durée de la session, comme si le jeton d'actualisation avait été révoqué. L'appel échouera avec un type d'erreur invalid_grant. Le champ error_subtype peut être utilisé pour faire la distinction entre un jeton révoqué et un échec dû à une règle de contrôle de session (par exemple, "error_subtype": "invalid_rapt"). Étant donné que les durées de session peuvent être très limitées (entre 1 et 24 heures), ce scénario doit être géré de manière fluide 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 les identifiants utilisateur sont déployés sur un serveur pour des opérations ou des tâches 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 expirera.

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 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.