Association de comptes Google avec OAuth

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.

In the implicit flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from Google.

In the authorization code flow, you need two endpoints:

  • The authorization endpoint, which presents the sign-in UI to your users that aren't already signed in. The authorization endpoint also creates a short-lived authorization code to record users' consent to the requested access.

  • The token exchange endpoint, which is responsible for two types of exchanges:

    1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
    2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Choose an OAuth 2.0 flow

Although the implicit flow is simpler to implement, Google recommends that access tokens issued by the implicit flow never expire. This is because the user is forced to link their account again after a token expires with the implicit flow. If you need token expiration for security reasons, we strongly recommend that you use the authorization code flow instead.

Design guidelines

This section describes the design requirements and recommendations for the user screen that you host for OAuth linking flows. After it's called by Google's app, your platform displays a sign in to Google page and account linking consent screen to the user. The user is directed back to Google's app after giving their consent to link accounts.

This figure shows the steps for a user to link their Google account to your authentication system. The first screenshot shows user-initiated linking from your platform. The second image shows user sign-in to Google, while the third shows the user consent and confirmation for linking their Google account with your app. The final screenshot shows a successfully linked user account in the Google app.
Figure 1. Account linking user sign in to Google and consent screens.

Requirements

  1. You must communicate that the user’s account will be linked to Google, not a specific Google product like Google Home or Google Assistant.

Recommendations

We recommend that you do the following:

  1. Display Google's Privacy Policy. Include a link to Google’s Privacy Policy on the consent screen.

  2. Data to be shared. Use clear and concise language to tell the user what data of theirs Google requires and why.

  3. Clear call-to-action. State a clear call-to-action on your consent screen, such as “Agree and link.” This is because users need to understand what data they're required to share with Google to link their accounts.

  4. Ability to cancel. Provide a way for users to go back or cancel, if they choose not to link.

  5. Clear sign-in process. Ensure that users have clear method for signing in to their Google account, such as fields for their username and password or Sign in with Google.

  6. Ability to unlink. Offer a mechanism for users to unlink, such as a URL to their account settings on your platform. Alternatively, you can include a link to Google Account where users can manage their linked account.

  7. Ability to change user account. Suggest a method for users to switch their account(s). This is especially beneficial if users tend to have multiple accounts.

    • If a user must close the consent screen to switch accounts, send a recoverable error to Google so the user can sign in to the desired account with OAuth linking and the implicit flow.

  8. Include your logo. Display your company logo on the consent screen. Use your style guidelines to place your logo. If you wish to also display Google's logo, see Logos and trademarks.

Créer le projet

Pour créer votre projet afin d'utiliser l'association de comptes:

  1. Go to the Google API Console.
  2. Cliquez sur Créer un projet .
  3. Saisissez un nom ou acceptez la suggestion générée.
  4. Confirmez ou modifiez les champs restants.
  5. Cliquez sur Créer .

Pour afficher votre ID de projet:

  1. Go to the Google API Console.
  2. Trouvez votre projet dans le tableau de la page de destination. L'ID du projet apparaît dans la colonne ID .

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.

  1. Ouvrez la page de l'écran de consentement OAuth dans la console des API Google.
  2. Si vous y êtes invité, sélectionnez le projet que vous venez de créer.

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

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

La mise en œuvre d' un serveur OAuth 2.0 du flux de code d'autorisation se compose de deux points d' extrémité qui votre service met à la disposition par HTTPS. Le premier point de terminaison est le point de terminaison d'autorisation, qui est chargé de rechercher ou d'obtenir le consentement des utilisateurs pour l'accès aux données. Le point de terminaison d'autorisation présente une interface utilisateur de connexion à vos utilisateurs qui ne sont pas encore connectés et enregistre le consentement à l'accès demandé. Le deuxième point de terminaison est le point de terminaison d'échange de jetons, qui est utilisé pour obtenir des chaînes cryptées, appelées jetons, qui autorisent un utilisateur à accéder à votre service.

Lorsqu'une application Google doit appeler l'une des API de votre service, Google utilise ces points de terminaison ensemble pour obtenir l'autorisation de vos utilisateurs d'appeler ces API en leur nom.

Une session de flux de code d'autorisation OAuth 2.0 initiée par Google a le flux suivant :

  1. Google ouvre votre point de terminaison d'autorisation dans le navigateur de l'utilisateur. Si le flux a démarré sur un appareil vocal uniquement pour une action, Google transfère l'exécution vers un téléphone.
  2. L'utilisateur se connecte, s'il n'est pas déjà connecté, et autorise Google à accéder à ses données avec votre API, s'il ne l'a pas déjà fait.
  3. Votre service crée un code d'autorisation et il retourne à Google. Pour ce faire, redirigez le navigateur de l'utilisateur vers Google avec le code d'autorisation joint à la demande.
  4. Google envoie le code d'autorisation à votre point de terminaison d'échange jeton, qui vérifie le jeton authenticité du code et retourne un accès et un jeton rafraîchissement. Le jeton d'accès est un jeton de courte durée que votre service accepte comme informations d'identification pour accéder aux API. Le jeton d'actualisation est un jeton de longue durée que Google peut stocker et utiliser pour acquérir de nouveaux jetons d'accès lorsqu'ils expirent.
  5. Une fois que l'utilisateur a terminé le flux de liaison de compte, chaque demande ultérieure envoyée par Google contient un jeton d'accès.

Traiter les demandes d'autorisation

Lorsque vous devez effectuer l'association de comptes à l'aide du flux de code d'autorisation OAuth 2.0, Google envoie l'utilisateur à votre point de terminaison d'autorisation avec une demande qui inclut les paramètres suivants :

Paramètres du point de terminaison d'autorisation
client_id L'ID client que vous avez attribué à Google.
redirect_uri L'URL à laquelle vous envoyez la réponse à cette demande.
state Une valeur comptable qui est retransmise à Google sans modification dans l'URI de redirection.
scope En option: Un ensemble délimité par l' espace de chaînes de portée qui spécifient les données Google demande l' autorisation de.
response_type Le type de valeur à renvoyer dans la réponse. Pour le OAuth 2.0 flux de code d'autorisation, le type de réponse est toujours le code .
user_locale La langue compte Google RFC5646 format utilisé pour localiser votre contenu dans la langue de l'utilisateur.

Par exemple, si votre critère d'autorisation est disponible à https://myservice.example.com/auth , une demande pourrait ressembler à ce qui suit:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&scope=REQUESTED_SCOPES&response_type=code&user_locale=LOCALE

Pour que votre point de terminaison d'autorisation gère les demandes de connexion, procédez comme suit :

  1. Vérifiez que le client_id correspond à l'ID client que vous avez attribué à Google, et que le redirect_uri correspond à l'URL de redirection de Google pour votre service. Ces vérifications sont importantes pour éviter d'accorder l'accès à des applications clientes involontaires ou mal configurées. Si vous prendre en charge plusieurs flux OAuth 2.0, confirment également que le response_type est le code .
  2. Vérifiez si l'utilisateur est connecté à votre service. Si l'utilisateur n'est pas connecté, terminez le processus de connexion ou d'inscription de votre service.
  3. Générez un code d'autorisation que Google utilisera pour accéder à votre API. Le code d'autorisation peut être n'importe quelle valeur de chaîne, mais il doit représenter de manière unique l'utilisateur, le client auquel le jeton est destiné et l'heure d'expiration du code, et il ne doit pas être devinable. Vous émettez généralement des codes d'autorisation qui expirent après environ 10 minutes.
  4. Vérifiez que l'URL spécifiée par le redirect_uri paramètre a la forme suivante: 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
  https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
  5. Rediriger le navigateur de l'utilisateur à l'URL spécifiée par le redirect_uri paramètre. Inclure le code d'autorisation que vous venez de générer et l'original, la valeur d'état non modifié lorsque vous redirigez en ajoutant les code et l' state des paramètres. Voici un exemple de l'URL résultant: 
    https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

Gérer les demandes d'échange de jetons

Le point de terminaison d'échange de jetons de votre service est responsable de deux types d'échanges de jetons :

  • Échanger des codes d'autorisation pour des jetons d'accès et des jetons d'actualisation
  • Échanger des jetons d'actualisation contre des jetons d'accès

Les demandes d'échange de jetons incluent les paramètres suivants :

Paramètres de point de terminaison d'échange de jetons
client_id Une chaîne qui identifie l'origine de la demande en tant que Google. Cette chaîne doit être enregistrée dans votre système en tant qu'identifiant unique de Google.
client_secret Une chaîne secrète que vous avez enregistrée auprès de Google pour votre service.
grant_type Le type de jeton échangé. Il est soit authorization_code ou refresh_token .
code Lorsque grant_type=authorization_code , ce paramètre est le code Google reçu à partir de votre connexion ou point final d'échange symbolique.
redirect_uri Lorsque grant_type=authorization_code , ce paramètre est l'URL utilisée dans la demande d'autorisation initiale.
refresh_token Lorsque grant_type=refresh_token , ce paramètre est l'actualisation jeton Google reçu à partir de votre point de terminaison d'échange symbolique.
Échanger des codes d'autorisation pour des jetons d'accès et des jetons d'actualisation

Une fois que l'utilisateur s'est connecté et que votre point de terminaison d'autorisation a renvoyé un code d'autorisation de courte durée à Google, Google envoie une demande à votre point de terminaison d'échange de jetons pour échanger le code d'autorisation contre un jeton d'accès et un jeton d'actualisation.

Pour ces demandes, la valeur de grant_type est authorization_code , et la valeur du code est la valeur du code d'autorisation vous avait précédemment accordé à Google. Voici un exemple de demande d'échange d'un code d'autorisation contre un jeton d'accès et un jeton d'actualisation :

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

Pour échanger des codes d'autorisation pour un jeton d' accès et un jeton rafraîchissement, votre endpoint répond échange jeton à POST demandes en exécutant les étapes suivantes:

  1. Vérifiez que les client_id identifie l'origine de la demande comme origine autorisée, et que le client_secret correspond à la valeur attendue.
  2. Vérifiez que le code d'autorisation est valide et n'a pas expiré, et que l'ID client spécifié dans la demande correspond à l'ID client associé au code d'autorisation.
  3. Vérifiez que l'URL spécifiée par le redirect_uri paramètre est identique à la valeur utilisée dans la demande d'autorisation initiale.
  4. Si vous ne pouvez pas vérifier tous les critères ci - dessus, renvoie une erreur HTTP 400 Bad Request avec {"error": "invalid_grant"} comme le corps.
  5. Sinon, utilisez l'ID utilisateur du code d'autorisation pour générer un jeton d'actualisation et un jeton d'accès. Ces jetons peuvent être n'importe quelle valeur de chaîne, mais ils doivent représenter de manière unique l'utilisateur et le client auquel le jeton est destiné, et ils ne doivent pas être devinables. Pour les jetons d'accès, enregistrez également l'heure d'expiration du jeton, qui est généralement d'une heure après l'émission du jeton. Les jetons d'actualisation n'expirent pas.
  6. Retourne l'objet JSON suivant dans le corps de la réponse HTTPS:
    {
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN",
"refresh_token": "REFRESH_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}

Google stocke le jeton d'accès et le jeton d'actualisation pour l'utilisateur et enregistre l'expiration du jeton d'accès. Lorsque le jeton d'accès expire, Google utilise le jeton d'actualisation pour obtenir un nouveau jeton d'accès à partir de votre point de terminaison d'échange de jetons.

Échanger des jetons d'actualisation contre des jetons d'accès

Lorsqu'un jeton d'accès expire, Google envoie une demande à votre point de terminaison d'échange de jetons pour échanger un jeton d'actualisation contre un nouveau jeton d'accès.

Pour ces demandes, la valeur de grant_type est refresh_token , et la valeur de refresh_token est la valeur de l'actualisation jeton que vous avait précédemment accordé à Google. Voici un exemple de demande d'échange d'un jeton d'actualisation contre un jeton d'accès :

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

Pour échanger un rafraîchissement jeton pour un jeton d'accès, vos répond de point de terminaison d'échange de jeton à POST demandes en exécutant les étapes suivantes:

  1. Vérifiez que les client_id identifie l'origine de la demande comme Google, et que la client_secret correspond à la valeur attendue.
  2. Vérifiez que le jeton d'actualisation est valide et que l'ID client spécifié dans la demande correspond à l'ID client associé au jeton d'actualisation.
  3. Si vous ne pouvez pas vérifier tous les critères ci - dessus, renvoie une erreur HTTP 400 Bad Request avec {"error": "invalid_grant"} comme le corps.
  4. Sinon, utilisez l'ID utilisateur du jeton d'actualisation pour générer un jeton d'accès. Ces jetons peuvent être n'importe quelle valeur de chaîne, mais ils doivent représenter de manière unique l'utilisateur et le client auquel le jeton est destiné, et ils ne doivent pas être devinables. Pour les jetons d'accès, enregistrez également l'heure d'expiration du jeton, généralement une heure après l'émission du jeton.
  5. Renvoyez l'objet JSON suivant dans le corps de la réponse HTTPS :
    {
"token_type": "Bearer",
"access_token": " ACCESS_TOKEN ",
"expires_in": SECONDS_TO_EXPIRATION
}
Gérer les demandes d'informations sur les utilisateurs

Le point d'extrémité de userinfo est un OAuth 2.0 ressource protégée que les demandes de retour sur l'utilisateur liée. La mise en œuvre et l'hébergement du point de terminaison userinfo sont facultatifs, à l'exception des cas d'utilisation suivants :

Une fois que le jeton d'accès a été récupéré avec succès à partir de votre point de terminaison de jeton, Google envoie une demande à votre point de terminaison userinfo pour récupérer les informations de profil de base sur l'utilisateur lié.

en-têtes de demande de point de terminaison userinfo
Authorization header Le jeton d'accès de type Bearer.

Par exemple, si votre userinfo point final est disponible à https://myservice.example.com/userinfo , une demande pourrait ressembler à ce qui suit:

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

Pour que votre point de terminaison userinfo gère les demandes, procédez comme suit :

  1. Extrayez le jeton d'accès de l'en-tête d'autorisation et renvoyez les informations pour l'utilisateur associé au jeton d'accès.
  2. Si le jeton d'accès est non valide, un retour HTTP 401 erreur non autorisée avec l' utilisation du WWW-Authenticate - tête de réponse. Voici un exemple d'une réponse d'erreur userinfo:
    HTTP/1.1 401 Unauthorized
WWW-Authenticate: error="invalid_token",
error_description="The Access Token expired"
    Si un 401 non autorisé, ou toute autre réponse d'erreur échoue est retournée au cours du processus de liaison, l'erreur sera non récupérable, le jeton Récupéré sera mis au rebut et l'utilisateur aura pour relancer le processus de liaison.

  3. Si le jeton d'accès est valide, le retour et réponse HTTP 200 avec l'objet JSON suivant dans le corps du protocole HTTPS réponse: 

    {
"sub": "USER_UUID",
"email": "EMAIL_ADDRESS",
"given_name": "FIRST_NAME",
"family_name": "LAST_NAME",
"name": "FULL_NAME",
"picture": "PROFILE_PICTURE",
}
    Si votre userinfo retourne point final une réponse de succès HTTP 200, le jeton récupéré et demandes sont enregistrées contre Google de l'utilisateur Compte.

    réponse du point de terminaison userinfo
    sub Un identifiant unique qui identifie l'utilisateur dans votre système.
    email Adresse e-mail de l'utilisateur.
    given_name En option: Prénom de l'utilisateur.
    family_name Facultatif: Nom de l'utilisateur.
    name Facultatif: Nom complet de l'utilisateur.
    picture En option: photo du 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 :

  1. Cliquez sur Configuration des pour ouvrir la fenêtre Configuration OAuth 2.0.
  2. Dans le champ d'écoulement OAuth, sélectionnez côté client.
  3. Dans le domaine Endpoints OAuth, sélectionnez Personnalisé.
  4. Spécifiez votre point de terminaison OAuth 2.0 et l'ID client que vous avez attribué à Google dans les champs correspondants.
  5. 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.
  6. 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 :

  1. Cliquez sur le signe-avec le bouton Google.
  2. Choisissez le compte que vous souhaitez associer.
  3. Saisissez l'ID du service.
  4. Saisissez éventuellement une ou plusieurs étendues pour lesquelles vous demanderez l'accès.
  5. Cliquez sur Démarrer démo.
  6. Lorsque vous y êtes invité, confirmez que vous pouvez consentir et refuser la demande d'association.
  7. Confirmez que vous êtes redirigé vers votre plateforme.