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.
在隐式流程中，Google 会在用户的浏览器中打开您的授权端点。成功登录后，系统会将长期访问令牌返回到 Google。现在，从 Google 发送的每个请求中都包含此访问令牌。
在授权代码流程中，您需要两个端点：
授权端点 - 向尚未登录的用户显示登录界面。授权端点还会创建一个短期授权代码，用于记录用户针对所请求的访问权限的同意情况。
令牌交换端点，负责两种交换类型：
- 将授权代码交换为长期刷新令牌和短期访问令牌。这种交换会在用户完成帐号关联流程时进行。
- 将长期有效的刷新令牌交换为短期访问令牌。当 Google 需要新的访问令牌时，由于此令牌已过期，因此出现这种交换。
选择 OAuth 2.0 流程
虽然隐式数据流的实现过程更简单，但 Google 建议隐式数据流签发的访问令牌永远不会过期。这是因为在令牌随隐式流程过期后，用户被迫再次关联自己的帐号。出于安全考虑，如果您需要令牌过期，我们强烈建议您改为使用授权代码流程。
设计准则
本部分将介绍针对 OAuth 关联流程托管的用户屏幕的设计要求和建议。在由 Google 的应用调用后，您的平台会向用户显示“登录 Google”页面和帐号关联屏幕。用户同意关联帐号后，会被重定向回 Google 的应用。
要求
- 您必须告知用户该用户帐号将与 Google 关联，而不是与特定 Google 产品（例如 Google Home 或 Google 助理）关联。
建议
建议您执行以下操作：
显示 Google 的隐私权政策。在同意屏幕上添加指向 Google 隐私权政策的链接。
要共享的数据。使用简洁明了的语言向用户说明他们的 Google 需要哪些数据以及为何收集这些数据。
明确的号召性用语。在同意屏幕上提供明确的号召性用语，例如“同意并关联”。这是因为用户需要了解他们需要与 Google 共享哪些数据，才能关联帐号。
能够取消。如果用户不关联，则可以提供返回或取消的方式。
清除登录流程。确保用户有明确的登录 Google 帐号的方法，例如用户名和密码字段或使用 Google 帐号登录字段。
能够解除关联。为用户提供解除关联的机制，例如他们在平台上的帐号设置网址。或者，您也可以添加指向 Google 帐号的链接，以便用户可以管理关联的帐号。
能够更改用户帐号。推荐一种供用户切换帐号的方法。如果用户往往拥有多个帐号，这一点尤其有用。
- 如果用户必须关闭同意屏幕才能切换帐号，请向 Google 发送一个可恢复错误，以便用户通过 OAuth 关联和隐式流程登录所需帐号。
添加徽标。在同意屏幕上显示公司徽标。 根据样式指南放置徽标。如果您还希望显示 Google 的徽标，请参阅徽标和商标。
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
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 :
- 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.
- 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.
- 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.
- 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.
- 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 :
- Vérifiez que le
client_idcorrespond à l'ID client que vous avez attribué à Google, et que leredirect_uricorrespond à 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 leresponse_typeest lecode. - 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.
- 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.
- Vérifiez que l'URL spécifiée par le
redirect_uriparamètre a la forme suivante:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
- Rediriger le navigateur de l'utilisateur à l'URL spécifiée par le
redirect_uriparamè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 lescodeet l'statedes 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:
- Vérifiez que les
client_ididentifie l'origine de la demande comme origine autorisée, et que leclient_secretcorrespond à la valeur attendue. - 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.
- Vérifiez que l'URL spécifiée par le
redirect_uriparamètre est identique à la valeur utilisée dans la demande d'autorisation initiale. - 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. - 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.
- 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:
- Vérifiez que les
client_ididentifie l'origine de la demande comme Google, et que laclient_secretcorrespond à la valeur attendue. - 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.
- 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. - 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.
- 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 }
处理用户信息请求
该用户信息终端是一个OAuth 2.0保护的资源，对链接的用户返回的权利要求。实现和托管 userinfo 端点是可选的，以下用例除外：
从您的令牌端点成功检索访问令牌后，Google 会向您的 userinfo 端点发送请求，以检索有关链接用户的基本个人资料信息。
| userinfo 端点请求标头 | |
|---|---|
Authorization header | Bearer 类型的访问令牌。 |
例如，如果你的用户信息终端可在https://myservice.example.com/userinfo ，请求看起来像下面这样：
GET /userinfo HTTP/1.1 Host: myservice.example.com Authorization: Bearer ACCESS_TOKEN
要让您的 userinfo 端点处理请求，请执行以下步骤：
- 从 Authorization 标头中提取访问令牌并返回与访问令牌关联的用户的信息。
- 如果访问令牌无效，返回HTTP 401错误未经授权使用的
WWW-Authenticate响应头。下面是一个userinfo的错误响应的一个示例：HTTP/1.1 401 Unauthorized WWW-Authenticate: error="invalid_token", error_description="The Access Token expired"
如果一个401未经授权，或任何其它不成功错误响应在关联过程返回时，误差将是不可恢复的，所检索的令牌将被丢弃，并且用户将必须再次启动链接过程。 如果访问令牌是有效的，回国与以下JSON对象在HTTPS响应的身体HTTP 200回应：
{ "sub": "USER_UUID", "email": "EMAIL_ADDRESS", "given_name": "FIRST_NAME", "family_name": "LAST_NAME", "name": "FULL_NAME", "picture": "PROFILE_PICTURE", }如果你的用户信息端点返回一个HTTP 200成功响应，检索到的令牌和索赔登记针对用户的谷歌帐户。用户信息端点响应 sub标识系统中用户的唯一 ID。 email用户的电子邮件地址。 given_name可选：用户的名字。 family_name可选：用户的姓氏。 name可选：用户的全名。 picture可选：用户的档案图片。
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.