Les comptes sont associés à l'aide de flux implicites et code d'autorisation OAuth 2.0. Votre service doit être compatible avec les points de terminaison d'autorisation et d'échange de jetons conformes à OAuth 2.0.
Dans le flux implicite, Google ouvre votre point de terminaison d'autorisation dans le navigateur de l'utilisateur. Une fois la connexion établie, vous renvoyez un jeton d'accès de longue durée à Google. Ce jeton d'accès est désormais inclus dans chaque requête envoyée depuis Google.
Dans le flux de code d'autorisation, vous avez besoin de deux points de terminaison:
Le point de terminaison de l'autorisation, qui présente l'interface utilisateur de connexion aux utilisateurs qui ne sont pas encore connectés. Le point de terminaison de l'autorisation crée également un code d'autorisation de courte durée permettant d'enregistrer les utilisateurs et de donner leur consentement à l'accès demandé.
Le point de terminaison token Exchange, responsable de deux types de places de marché:
- Échange un code d'autorisation contre un jeton d'actualisation de longue durée et un jeton d'accès de courte durée. Cet échange se produit lorsque l'utilisateur suit le flux d'association de comptes.
- Échange un jeton d'actualisation de longue durée contre un jeton d'accès de courte durée. Cet échange se produit lorsque Google a besoin d'un nouveau jeton d'accès, car celui-ci a expiré.
Choisir un parcours OAuth 2.0
Bien que le flux implicite soit plus simple à mettre en œuvre, Google recommande que les jetons d'accès émis par le flux implicite n'expirent pas. En effet, l'utilisateur doit de nouveau associer son compte après l'expiration d'un jeton avec le parcours implicite. Si vous avez besoin d'un délai d'expiration du jeton pour des raisons de sécurité, nous vous recommandons vivement d'utiliser plutôt le flux de code d'autorisation.
Consignes relatives à la conception
Cette section décrit les exigences et les recommandations de conception pour l'écran d'utilisateur que vous hébergez dans les flux d'association OAuth. Une fois l'application appelée par Google, votre plate-forme affiche l'écran de consentement pour l'association d'un compte Google à une page Google. L'utilisateur est redirigé vers l'application Google après avoir consenti à l'association des comptes.
Conditions requises
- Vous devez indiquer que le compte de l'utilisateur sera associé à Google, et non à un produit Google spécifique tel que Google Home ou Assistant Google.
Recommandations
Nous vous recommandons d'effectuer les opérations suivantes :
Afficher les règles de confidentialité de Google. Incluez un lien vers les Règles de confidentialité de Google sur l'écran de consentement.
Données à partager. Utilisez un langage clair et concis pour indiquer à l'utilisateur les informations requises par Google et pourquoi.
Incitation à l'action claire. Indiquer une incitation à l'action claire sur votre écran de consentement, par exemple "Accepter et associer", car les utilisateurs doivent comprendre quelles données ils sont tenus de partager avec Google pour associer leurs comptes.
Possibilité d'annulation. Permettez aux utilisateurs de revenir en arrière ou d'annuler s'ils décident de ne pas créer de lien.
Processus de connexion clair. Assurez-vous que les utilisateurs disposent d'une méthode claire pour se connecter à leur compte Google, telle que des champs pour leur nom d'utilisateur et leur mot de passe, ou encore Se connecter avec Google.
Possibilité de dissocier. Proposez aux utilisateurs un mécanisme à dissocier, comme une URL renvoyant vers les paramètres de leur compte sur votre plate-forme. Vous pouvez également inclure un lien vers un compte Google dans lequel les utilisateurs peuvent gérer leur compte associé.
Possibilité de changer de compte utilisateur Suggérez une méthode permettant aux utilisateurs de changer de compte. C'est particulièrement intéressant si les utilisateurs ont généralement plusieurs comptes.
- Si un utilisateur doit fermer l'écran de consentement pour changer de compte, envoyez une erreur reproductible à Google afin qu'il puisse se connecter au compte souhaité avec l'association OAuth et le flux implicite.
Incluez votre logo. afficher le logo de votre entreprise sur l'écran de consentement ; Utilisez les consignes de style pour placer votre logo. Si vous souhaitez également afficher le logo Google, consultez Logos et marques.
Créer le projet
Pour créer votre projet afin d'utiliser l'association de comptes:
- Go to the Google API Console.
- Cliquez sur Créer un projet .
- Saisissez un nom ou acceptez la suggestion générée.
- Confirmez ou modifiez les champs restants.
- Cliquez sur Créer .
Pour afficher votre ID de projet:
- Go to the Google API Console.
- Trouvez votre projet dans le tableau de la page de destination. L'ID du projet apparaît dans la colonne ID .
Configurer votre écran de consentement OAuth
Le processus d'association de comptes Google comprend un écran de consentement qui indique aux utilisateurs l'application qui demande l'accès à leurs données, le type de données qu'ils demandent et les conditions qui s'appliquent. Vous devrez configurer votre écran de consentement OAuth avant de générer un ID client pour l'API Google.
- Ouvrez la page de l'écran de consentement OAuth dans la console des API Google.
- Si vous y êtes invité, sélectionnez le projet que vous venez de créer.
Sur la page "Écran de consentement OAuth", remplissez le formulaire et cliquez sur le bouton "Enregistrer".
Nom de l'application:nom de l'application demandant le consentement des utilisateurs. Le nom doit refléter précisément votre application et correspondre à celui que les utilisateurs voient ailleurs. Le nom de l'application s'affichera sur l'écran de consentement pour l'association de comptes.
Logo de l'application:image qui s'affiche sur l'écran de consentement pour aider les utilisateurs à reconnaître votre application. Le logo est affiché sur l'écran de consentement pour l'association de comptes et dans les paramètres du compte.
Adresse e-mail d'assistance:cette option permet aux utilisateurs de vous contacter pour vous poser des questions sur leur consentement.
Champs d'application pour les API Google:les champs d'application permettent à votre application d'accéder aux données Google privées de vos utilisateurs. Pour le cas d'utilisation de l'association de comptes Google, le champ d'application par défaut (adresse e-mail, profil, openid) est suffisant. Vous n'avez pas besoin d'ajouter de champs d'application sensibles. 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'au départ. (en savoir plus).
Domaines autorisés:afin de vous protéger, vous et vos utilisateurs, Google n'autorise que les applications qui s'authentifient via OAuth à utiliser des domaines autorisés. Les liens de vos applications doivent être hébergés sur des domaines autorisés. (en savoir plus).
Lien vers la page d'accueil de l'application:page d'accueil de votre application. Doit être hébergé sur un domaine autorisé.
Lien vers les règles de confidentialité de l'application:s'affiche sur l'écran de consentement pour l'association de comptes Google. Doit être hébergé sur un domaine autorisé.
Lien vers les conditions d'utilisation de l'application (facultatif) : doit être hébergé sur un domaine autorisé.
Figure 1 : Écran de consentement pour l'association de comptes Google pour une application fictive, Tunery
Vérifiez l'état de validation de votre demande, puis cliquez sur le bouton "Envoyer pour validation". Pour en savoir plus, consultez les conditions de validation OAuth.
Implémenter votre serveur OAuth
Pour prendre en charge le flux implicite OAuth 2.0, votre service accorde une autorisation un point de terminaison unique disponible via HTTPS. Ce point de terminaison est responsable de l'authentification l'obtention du consentement des utilisateurs pour l'accès aux données. Le point de terminaison d'autorisation présente une interface utilisateur de connexion aux utilisateurs qui ne sont pas déjà connectés et enregistre autoriser l'accès demandé.
Lorsqu'une application Google doit appeler l'une des API autorisées de votre service, Google utilise ce point de terminaison pour obtenir l'autorisation de vos utilisateurs d'appeler ces API en son nom.
Une session de flux implicite OAuth 2.0 typique lancée par Google possède le flux suivant:
- Google ouvre votre point de terminaison d'autorisation dans le navigateur de l'utilisateur. La se connecte (s'il ne l'est pas déjà) et autorise Google à accéder à leurs données avec votre API, s'ils ne l'ont pas déjà accordé.
- Votre service crée un jeton d'accès et le renvoie à Google Pour ce faire, redirigez le navigateur de l'utilisateur vers Google associé à la requête.
- Google appelle les API de votre service et associe le jeton d'accès chaque requête. Votre service vérifie que le jeton d'accès accorde à Google l'autorisation d'accès à l'API, puis termine l'appel d'API.
Gérer les requêtes d'autorisation
Lorsqu'une application Google doit associer un compte via une méthode OAuth 2.0 flux implicite, Google redirige l'utilisateur vers votre point de terminaison d'autorisation qui inclut les paramètres suivants:
| Paramètres du point de terminaison de l'autorisation | |
|---|---|
client_id |
ID client que vous avez attribué à Google. |
redirect_uri |
URL à laquelle vous envoyez la réponse à cette requête. |
state |
Une valeur de tenue de registre renvoyée à Google telle quelle dans le l'URI de redirection. |
response_type |
Type de valeur à renvoyer dans la réponse. Pour l'authentification OAuth 2.0
le type de réponse est toujours token. |
user_locale |
Le paramètre linguistique du compte Google RFC5646 format utilisé pour localiser votre contenu dans la langue préférée de l'utilisateur. |
Par exemple, si votre point de terminaison d'autorisation est disponible
https://myservice.example.com/auth, une requête peut se présenter comme suit:
GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token&user_locale=LOCALE
Pour que votre point de terminaison d'autorisation traite les requêtes de connexion, procédez comme suit : étapes:
Vérifiez les valeurs
client_idetredirect_uripour pour empêcher l'octroi d'accès à des applications clientes non intentionnelles ou mal configurées:- Vérifiez que
client_idcorrespond à l'ID client que vous attribué à Google. - Vérifiez que l'URL spécifiée par
redirect_uria la forme suivante:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
- Vérifiez que
Vérifiez si l'utilisateur est connecté à votre service. Si l'utilisateur n'est pas signé suivez la procédure de connexion ou d'inscription de votre service.
Générez un jeton d'accès que Google utilisera pour accéder à votre API. La Le jeton d'accès peut correspondre à n'importe quelle valeur de chaîne, mais il doit représenter de manière unique le user et le client pour lequel le jeton est destiné et ne doit pas être devinable.
Envoyer une réponse HTTP qui redirige le navigateur de l'utilisateur vers l'URL spécifiée par le paramètre
redirect_uri. Incluez tous les les paramètres suivants dans le fragment d'URL:access_token: jeton d'accès que vous venez de générertoken_type: chaînebearerstate: valeur de l'état non modifié de l'original demander
Voici un exemple de l'URL obtenue:
https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING
Le gestionnaire de redirection OAuth 2.0 de Google reçoit le jeton d'accès et confirme
que la valeur state n'a pas changé. Une fois que Google a obtenu
pour votre service, le jeton est associé aux appels suivants
à vos API de service.
Gérer les requêtes userinfo
Le point de terminaison userinfo est une ressource protégée par OAuth 2.0 qui renvoie les revendications concernant l'utilisateur associé. L'implémentation et l'hébergement du point de terminaison userinfo sont facultatifs, sauf dans les cas d'utilisation suivants:
- Connexion à un compte associé avec Google One Tap.
- Abonnement simplifié sur Android TV.
Une fois que le jeton d'accès a été récupéré avec succès à partir du point de terminaison de votre jeton, Google envoie une demande à ce point de terminaison pour récupérer les informations de base du profil sur l'utilisateur associé.
| En-têtes de requête du point de terminaison userinfo | |
|---|---|
Authorization header |
Jeton d'accès de type Bearer. |
Par exemple, si votre point de terminaison userinfo est disponible à l'adresse
https://myservice.example.com/userinfo, une requête peut se présenter comme suit:
GET /userinfo HTTP/1.1 Host: myservice.example.com Authorization: Bearer ACCESS_TOKEN
Pour que votre point de terminaison userinfo traite les requêtes, procédez comme suit:
- Extrayez le jeton d'accès de l'en-tête "Authorization" et renvoyez les informations concernant l'utilisateur associé au jeton d'accès.
- Si le jeton d'accès n'est pas valide, renvoyez une erreur HTTP 401 Opération non autorisée à l'aide de l'en-tête de réponse
WWW-Authenticate. Voici un exemple de réponse d'erreur userinfo:HTTP/1.1 401 Unauthorized WWW-Authenticate: error="invalid_token", error_description="The Access Token expired"
Si une erreur 401 (autorisation non autorisée) ou toute autre erreur est renvoyée pendant le processus d'association, l'erreur ne pourra pas être récupérée, le jeton récupéré sera supprimé et l'utilisateur devra recommencer le processus d'association. Si le jeton d'accès est valide, renvoyez une réponse HTTP 200 avec l'objet JSON suivant dans le corps de la requête réponse:
{ "sub": "USER_UUID", "email": "EMAIL_ADDRESS", "given_name": "FIRST_NAME", "family_name": "LAST_NAME", "name": "FULL_NAME", "picture": "PROFILE_PICTURE", }Si votre point de terminaison userinfo renvoie une réponse de réussite HTTP 200, le jeton et les revendications récupérés sont enregistrés sur le compte Google de l'utilisateur.Réponse du point de terminaison userinfo subIdentifiant unique qui identifie l'utilisateur dans votre système. emailAdresse e-mail de l'utilisateur. given_nameFacultatif:prénom de l'utilisateur. family_nameFacultatif:nom de l'utilisateur. nameFacultatif:nom complet de l'utilisateur. pictureFacultatif:photo de profil de l'utilisateur.
Valider votre intégration
Vous pouvez valider votre implémentation en utilisant le Playground OAuth 2.0 outil.
Dans l'outil, procédez comme suit :
- Cliquez sur Configuration des pour ouvrir la fenêtre Configuration OAuth 2.0.
- Dans le champ d'écoulement OAuth, sélectionnez côté client.
- Dans le domaine Endpoints OAuth, sélectionnez Personnalisé.
- Spécifiez votre point de terminaison OAuth 2.0 et l'ID client que vous avez attribué à Google dans les champs correspondants.
- Dans la section Étape 1, ne sélectionnez pas de champs Google. Au lieu de cela, laissez ce champ vide ou saisissez une étendue valide pour votre serveur (ou une chaîne arbitraire si vous n'utilisez pas d'étendues OAuth). Lorsque vous avez terminé, cliquez sur Autoriser les API.
- Dans les étapes 2 et 3 sections, passez par le flux OAuth 2.0 et vérifiez que chaque étape fonctionne comme prévu.
Vous pouvez valider votre implémentation en utilisant le compte Google Linking Demo outil.
Dans l'outil, procédez comme suit :
- Cliquez sur le signe-avec le bouton Google.
- Choisissez le compte que vous souhaitez associer.
- Saisissez l'ID du service.
- Saisissez éventuellement une ou plusieurs étendues pour lesquelles vous demanderez l'accès.
- Cliquez sur Démarrer démo.
- Lorsque vous y êtes invité, confirmez que vous pouvez consentir et refuser la demande d'association.
- Confirmez que vous êtes redirigé vers votre plateforme.