Google s'est engagé à promouvoir l'équité raciale pour les communautés noires. Regarde comment.

Utiliser OAuth 2.0 pour accéder aux API Google

API Google utilisent le protocole OAuth 2.0 pour l' authentification et l' autorisation. Google prend en charge les scénarios OAuth 2.0 courants, tels que ceux des applications de serveur Web, côté client, installées et de périphérique à entrée limitée.

Pour commencer, obtenir des informations d' identification de client OAuth 2.0 de la 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 envoie le jeton à l'API Google à laquelle vous souhaitez accéder. Pour une démonstration interactive en utilisant OAuth 2.0 avec Google (y compris la possibilité d'utiliser vos propres informations d' identification du client), expérience avec le OAuth 2.0 Playground .

Cette page donne un aperçu des scénarios d'autorisation OAuth 2.0 pris en charge par Google et fournit des liens vers un contenu plus détaillé. Pour plus de détails sur l' utilisation de OAuth 2.0 pour l' authentification, voir OpenID Connect .

Étapes de base

Toutes les applications suivent un modèle de base lors de l'accès à une API Google à l'aide d'OAuth 2.0. À un niveau élevé, vous suivez cinq étapes :

1. Obtenir des informations d' identification OAuth 2.0 de la Google API Console.

Visitez le Google API Console pour obtenir des informations d' identification OAuth 2.0 comme un ID client et secret client qui sont connus à la fois Google et 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 secret, mais une application de serveur Web le fait.

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

Il existe plusieurs façons de faire cette demande, 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 demandes de service Web.

Certaines demandes nécessitent une étape d'authentification où l'utilisateur se connecte avec son compte Google. Une fois connecté, il est demandé à l'utilisateur s'il est prêt à accorder une ou plusieurs autorisations demandées par votre application. Ce processus est appelé le 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 étendues d'accès accordées 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 étendues de manière incrémentielle, au moment où l'accès est requis, plutôt qu'à l'avance. Par exemple, une application qui souhaite prendre en charge l'enregistrement d'un événement dans un calendrier ne doit pas demander l'accès à Google Agenda tant que l'utilisateur n'a pas appuyé sur le bouton « Ajouter au calendrier » ; voir autorisation incrémentale .

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

Comparez les étendues incluses dans la réponse du jeton d'accès aux étendues requises pour accéder aux fonctionnalités et 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 incapables de fonctionner sans accès à l'API associée.

L'étendue incluse dans votre demande peut ne pas correspondre à l'étendue incluse dans votre réponse, même si l'utilisateur a accordé toutes les étendues demandées. Reportez-vous à la documentation de chaque API Google pour connaître les étendues requises pour l'accès. Une API peut mapper plusieurs valeurs de chaîne de portée à une seule portée d'accès, renvoyant la même chaîne de portée pour toutes les valeurs autorisées dans la demande. Exemple: l'API Google Les gens peuvent retourner un champ d' https://www.googleapis.com/auth/contacts lorsqu'une application a demandé un utilisateur autorise une portée de https://www.google.com/m8/feeds/ ; la méthode API Google People people.updateContact nécessite une portée accordée de https://www.googleapis.com/auth/contacts .

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

Après une application obtient un jeton d' accès, il envoie le jeton à une API Google dans une tête de requête HTTP d' autorisation . 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 complètement sécurisés. En outre, il est recommandé d'éviter de créer des noms de paramètres URI inutiles. Notez que la prise en charge de la chaîne de requête sera obsolète le 1er juin 2021.

Les jetons d'accès ne sont valables 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 Calendar, il n'accorde pas l'accès à l'API Google Contacts. Vous pouvez cependant envoyer ce jeton d'accès à l'API Google Calendar 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 prend en charge 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 ; l'URL comprend 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 de rafraîchissement.

L'application doit stocker le jeton d'actualisation pour une utilisation future 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 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 plus de détails, voir Utiliser OAuth 2.0 pour les applications serveur Web .

Applications installées

Le point de terminaison Google OAuth 2.0 prend en charge 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 le Google API Console , préciser que c'est une application installée, puis sélectionnez Android, Chrome app, iOS, plate - forme Windows (Universal UWP), ou une application de bureau comme le type d'application.

Le processus génère un ID client et, dans certains cas, un secret client, que vous intégrez dans le code source de votre application. (Dans ce contexte, le secret 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 comprend 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 de rafraîchissement.

L'application doit stocker le jeton d'actualisation pour une utilisation future 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 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 plus de détails, voir Utilisation de OAuth 2.0 pour les applications installées .

Applications côté client (JavaScript)

Le point de terminaison Google OAuth 2.0 prend en charge 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 ; l'URL comprend 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 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, valide le jeton et utilise le jeton pour appeler un point de terminaison d'API Google.

Pour plus de détails, voir Utilisation de OAuth 2.0 pour les applications côté client .

Applications sur des appareils à entrée limitée

Le point de terminaison Google OAuth 2.0 prend en charge les applications qui s'exécutent sur des appareils à entrée limitée tels que les consoles de jeux, les caméras vidéo et les imprimantes.

La séquence d'autorisation commence lorsque l'application fait une demande de service Web à une URL Google pour un code d'autorisation. La réponse contient plusieurs paramètres, dont une URL et un code que l'application montre à l'utilisateur.

L'utilisateur obtient l'URL et le code de l'appareil, puis passe à un autre appareil ou ordinateur avec des 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 future 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 plus de détails, voir l' aide OAuth 2.0 pour les périphériques .

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 de l'utilisateur. 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 un accès délégué à certaines ressources.

Pour ces types d'interactions serveur-à-serveur , vous avez besoin d' un compte de service, qui est un compte qui appartient à votre application au lieu de un individu utilisateur final. 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 au nom des utilisateurs finaux, et le consentement de l'utilisateur est parfois requis.)

Les informations d' identification d'un compte de service, que vous obtenez de la Google API Console, comprennent une adresse e - mail généré qui est unique, un identifiant 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 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 plus de détails, consultez la documentation service compte .

Taille du jeton

Les jetons peuvent varier en taille, dans les limites suivantes :

  • Codes d'autorisation : 256 octets
  • Jetons d'accès : 2048 octets
  • Jetons de rafraîchissement : 512 octets

Accès jetons retourné par de Google Cloud API Security Token Service sont structurées de façon similaire à l' API Google OAuth 2.0 jetons d'accès mais ont des limites de taille de jeton. Pour plus de détails, consultez la documentation de l' API .

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

Actualiser l'expiration du jeton

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 :

  • 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é les mots de passe et le jeton d'actualisation contient des étendues Gmail.
  • Le compte d'utilisateur a dépassé le nombre maximal de jetons d'actualisation accordés (en direct).
  • L'utilisateur appartient à une organisation Google Cloud Platform qui applique des règles de contrôle de session.

Un projet Google Cloud Platform avec un écran de consentement OAuth configuré pour un type d'utilisateur externe et un statut de publication "Test" reçoit un jeton d'actualisation expirant dans 7 jours.

Il existe actuellement une limite de 50 jetons d'actualisation par compte Google et par ID client OAuth 2.0. Si la limite est atteinte, la création d'un nouveau jeton d'actualisation invalide automatiquement le plus ancien jeton d'actualisation sans avertissement. Cette limite ne concerne pas les comptes de service .

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

Si vous avez besoin d'autoriser plusieurs programmes, machines ou appareils, une solution de contournement est de limiter le nombre de clients que vous autorisez par compte Google à 15 ou 20. Si vous êtes un administrateur Google Espace de travail , vous pouvez créer d' autres utilisateurs avec des privilèges d' administration et les utiliser pour autoriser certains des clients.

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

Les administrateurs d'organisations de GCP pourraient avoir besoin reauthentication fréquentes des utilisateurs pendant qu'ils accèdent aux ressources GCP, en utilisant la fonction de contrôle de session Google Cloud . Cela a un impact sur la politique d' accès à Google Cloud Console, le SDK Google Cloud (également connu sous le nom CLI gcloud), et toute application OAuth tiers qui exige la portée Cloud Platform. Si un utilisateur a une politique de contrôle de session en place puis à l'expiration de la durée de la session, vos appels API erreur sur semblable à ce qui se passerait si l'actualisation jeton a été annulé - l'appel échoue avec un type d'erreur invalid_token ; le type de sous-erreur peut être utilisé pour faire la distinction entre un jeton de révocation et un échec dû à une politique de contrôle de session. Comme les durées de session peuvent être très limitées (entre 1 heure et 24 heures), ce scénario doit être géré avec élégance en redémarrant une session d'authentification.

De même, vous ne devez pas utiliser ou encourager l'utilisation d'informations d'identification d'utilisateur pour le déploiement de serveur à serveur. Si les informations d'identification de l'utilisateur sont déployées sur un serveur pour des tâches ou des opérations de longue durée et qu'un client applique des politiques de contrôle de session sur 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 expire.

Pour plus d' informations sur la façon d'aider vos clients à déployer cette fonctionnalité, reportez - vous à cet article d'aide admin-ciblée.

Bibliothèques clientes

Les bibliothèques clientes suivantes s'intègrent aux frameworks populaires, ce qui simplifie la mise en œuvre d'OAuth 2.0. Plus de fonctionnalités seront ajoutées aux bibliothèques au fil du temps.