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

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.

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é:
1. É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.
2. É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.

Cette figure montre les étapes à suivre par un utilisateur pour associer son compte Google à votre système d'authentification. La première capture d'écran montre un lien lancé par l'utilisateur depuis votre plate-forme. La deuxième image montre la connexion des utilisateurs à Google, tandis que la troisième montre le consentement de l'utilisateur et la confirmation de l'association de son compte Google à votre application. La capture d'écran finale montre un compte utilisateur associé dans l'appli Google. — **Figure 1.** L'utilisateur doit associer son compte à Google et ses écrans de consentement.

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

Une mise en œuvre serveur OAuth 2.0 du flux de code d'autorisation comprend les éléments suivants : deux points de terminaison, que votre service met à disposition via HTTPS. Le premier point de terminaison est le point de terminaison d'autorisation chargé de trouver 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 qui n'est pas déjà connectée et qui enregistre le consentement des utilisateurs. l'accès demandé. Le deuxième point de terminaison est le point de terminaison de l'échange de jetons, est utilisé pour obtenir des chaînes chiffré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 pour obtenir l'autorisation de vos utilisateurs d'appeler ces API en son nom.

Une session de flux avec code d'autorisation OAuth 2.0 initiée par Google dispose du flux suivant:

Google ouvre votre point de terminaison d'autorisation dans le navigateur de l'utilisateur. Si le flux sur un appareil à commande vocale pour une action, Google transfère l'exécution sur un téléphone.
L'utilisateur se connecte, s'il n'est pas déjà connecté, 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 code d'autorisation et le renvoie à Google. À faire Redirigez donc le navigateur de l'utilisateur vers Google avec le code d'autorisation joint à la demande.
Google envoie le code d'autorisation au point de terminaison de votre échange de jetons, qui vérifie l'authenticité du code et renvoie un jeton d'accès et une jeton d'actualisation. Le jeton d'accès est un jeton de courte durée que votre service accepte comme identifiants d'accès aux API. Le jeton d'actualisation est un jeton que Google peut stocker et utiliser pour obtenir de nouveaux jetons d'accès arrive à expiration.
Une fois que l'utilisateur a terminé le processus d'association de compte, toutes les étapes suivantes envoyée par Google contient un jeton d'accès.

Gérer les requêtes d'autorisation

Lorsque vous devez associer des comptes à l'aide du code d'autorisation OAuth 2.0 flux d'autorisation, Google redirige l'utilisateur vers votre point de terminaison d'autorisation avec une requête comprend 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.
`scope`	Facultatif:un ensemble de chaînes de champ d'application délimitées par un espace qui spécifient le pour lesquelles Google demande une autorisation.
`response_type`	Type de valeur à renvoyer dans la réponse. Pour le protocole OAuth 2.0, flux avec code d'autorisation, le type de réponse est toujours `code`.
`user_locale`	Le paramètre linguistique du compte Google RFC5646 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&scope=REQUESTED_SCOPES&response_type=code&user_locale=LOCALE

Pour que votre point de terminaison d'autorisation traite les requêtes de connexion, procédez comme suit : étapes:

Vérifiez que client_id correspond à l'ID client que vous avez attribué à Google et que redirect_uri correspond à l'URL de redirection fournie par Google pour votre service. Ces vérifications sont importantes pour empêcher l'accès à des applications clientes non intentionnelles ou mal configurées. Si vous acceptez plusieurs Pour les flux OAuth 2.0, vérifiez également que response_type est défini sur code.
Vérifiez si l'utilisateur est connecté à votre service. Si l'utilisateur n'est pas connecté, terminer 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 être unique représenter l'utilisateur, le client auquel le jeton est destiné et la date d'expiration du code et ne doit pas être devinable. Vous émettez généralement une autorisation codes qui expirent au bout de 10 minutes environ.

Vérifiez que l'URL spécifiée par le paramètre redirect_uri comporte le ce formulaire:

  https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
  https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID

Redirigez le navigateur de l'utilisateur vers l'URL spécifiée par le paramètre Paramètre redirect_uri. Indiquez le code d'autorisation généré et la valeur d'état non modifiée d'origine lorsque vous redirigez en ajoutant les paramètres code et state. Voici un exemple exemple de l'URL obtenue:
```
https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING
```

Gérer les requêtes d'échange de jetons

Le point de terminaison de l'échange de jetons de votre service est responsable de deux types de jetons places de marché:

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

Les requêtes d'échange de jetons incluent les paramètres suivants:

Paramètres du point de terminaison d'échange de jetons
`client_id`	Chaîne identifiant Google à l'origine de la requête. Cette chaîne ne doit doit être enregistré dans votre système en tant qu'identifiant unique de Google.
`client_secret`	Chaîne secrète que vous avez enregistrée auprès de Google pour votre service.
`grant_type`	Type de jeton échangé. C'est soit `authorization_code` ou `refresh_token`.
`code`	Si la valeur est `grant_type=authorization_code`, ce paramètre correspond au code que Google a reçu de votre connexion ou de votre échange de jetons point de terminaison unique.
`redirect_uri`	Si la valeur est `grant_type=authorization_code`, ce paramètre correspond au URL utilisée dans la requête d'autorisation initiale.
`refresh_token`	Si la valeur est `grant_type=refresh_token`, ce paramètre correspond au jeton d'actualisation que Google a reçu du point de terminaison de votre échange de jetons.

Échangez des codes d'autorisation contre des jetons d'accès et d'actualisation

Une fois que l'utilisateur s'est connecté et que votre point de terminaison d'autorisation renvoie un code d'autorisation à Google, celui-ci envoie une demande à votre échange de jetons pour échanger le code d'autorisation contre un jeton d'accès et une actualisation à partir d'un jeton d'accès.

Pour ces requêtes, la valeur de grant_type est authorization_code, et La valeur code correspond à la valeur du code d'autorisation que vous avez accordé précédemment. à Google. Voici un exemple de requête d'échange un code d'autorisation pour 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 contre un jeton d'accès et un jeton d'actualisation, votre Le point de terminaison de l'échange de jetons répond aux requêtes POST en exécutant la commande suivante : étapes:

Vérifiez que client_id identifie l'origine de la requête comme étant autorisée l'origine et que client_secret correspond à la valeur attendue.
Vérifiez que le code d'autorisation est valide et qu'il n'a pas expiré, et que le spécifié dans la requête correspond à l'identifiant client associé au d'autorisation.
Vérifiez que l'URL spécifiée par le paramètre redirect_uri est identique à la valeur utilisée dans la requête d'autorisation initiale.
Si vous ne pouvez pas vérifier tous les critères ci-dessus, renvoyez une réponse Erreur 400 "Requête incorrecte" avec {"error": "invalid_grant"} dans le corps.
Sinon, utilisez l'ID utilisateur du code d'autorisation pour générer une actualisation. et un jeton d'accès. Ces jetons peuvent être de n'importe quelle valeur de chaîne, mais ils doit représenter de manière unique l'utilisateur et le client pour lequel le jeton est destiné. ne doit pas être devinable. Pour les jetons d'accès, notez également l'heure d'expiration le jeton, qui est généralement une heure après son émission. Les jetons d'actualisation n'expirent pas.

Renvoyez 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 les enregistrements 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 du point de terminaison de votre é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 échange de jetons pour échanger un jeton d'actualisation contre un nouveau jeton d'accès.

Pour ces requêtes, la valeur de grant_type est refresh_token, et la valeur de refresh_token est la valeur du jeton d'actualisation que vous avez précédemment accordé Google Voici un exemple de requête d'échange d'un jeton d'actualisation pour 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 jeton d'actualisation contre un jeton d'accès, votre point de terminaison échange répond aux requêtes POST en procédant comme suit:

Vérifiez que client_id identifie l'origine de la requête comme étant Google. que client_secret correspond à la valeur attendue.
Vérifiez que le jeton d'actualisation est valide et que l'ID client spécifié dans la requête correspond à l'ID client associé au jeton d'actualisation.
Si vous ne pouvez pas vérifier tous les critères ci-dessus, renvoyez une erreur HTTP 400 Erreur de requête incorrecte avec {"error": "invalid_grant"} dans le corps.
Sinon, utilisez l'ID utilisateur du jeton d'actualisation pour générer un accès à partir d'un jeton d'accès. Ces jetons peuvent correspondre à n'importe quelle valeur de chaîne, mais ils doivent être uniques représentent l'utilisateur et le client auquel est destiné le jeton, et ils ne doivent pas être devinable. 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 requête réponse:

{
"token_type": "Porteur",
"access_token": "ACCESS_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}

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
`sub`	Identifiant unique qui identifie l'utilisateur dans votre système.
`email`	Adresse e-mail de l'utilisateur.
`given_name`	Facultatif:prénom de l'utilisateur.
`family_name`	Facultatif:nom de l'utilisateur.
`name`	Facultatif:nom complet de l'utilisateur.
`picture`	Facultatif: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.