Présentation
L'association simplifiée avec Google Sign-In basée sur OAuth ajoute Google Sign-In Association OAuth : Cela offre une expérience d'association transparente pour les utilisateurs Google, et la création de compte, qui permet à l'utilisateur de créer un nouveau compte sur votre service à l'aide de son compte Google.
Pour associer un compte avec OAuth et Google Sign-In, procédez comme suit : étapes:
- Commencez par demander à l'utilisateur l'autorisation d'accéder à son profil Google.
- Utilisez les informations de son profil pour vérifier si le compte utilisateur existe.
- Pour les utilisateurs existants, associez les comptes.
- Si vous ne trouvez pas de correspondance pour l'utilisateur Google dans votre système d'authentification, valider le jeton d'ID reçu de Google. Vous pouvez ensuite créer un profil utilisateur sur les informations de profil contenues dans le jeton d'ID.
![Cette figure montre comment un utilisateur doit associer son compte Google à l'aide de la procédure d'association simplifiée. La première capture d'écran montre comment un utilisateur peut sélectionner votre application à associer. La deuxième capture d'écran permet à l'utilisateur de confirmer s'il possède déjà un compte sur votre service. La troisième capture d'écran permet à l'utilisateur de sélectionner le compte Google qu'il souhaite associer. La quatrième capture d'écran montre la confirmation de l'association du compte Google à votre application. La cinquième capture d'écran montre un compte utilisateur correctement associé dans l'appli Google.](https://developers-dot-devsite-v2-prod.appspot.com/static/identity/account-linking/images/streamlined-linking-flow.png?authuser=4&hl=fr)
Figure 1 : Association de comptes sur le téléphone d'un utilisateur grâce à l'association simplifiée
Conditions requises pour l'association simplifiée
- Implémentez le flux d'association OAuth Web de base. Votre service doit être compatible avec OAuth 2.0 d'autorisation et d'échange de jetons.
- Votre point de terminaison d'échange de jetons doit accepter les assertions Jeton Web JSON (JWT) et implémenter les intents
check
,create
etget
.
Implémenter votre serveur OAuth
Votre point de terminaison d'échange de jetons doit être compatible avec les intents check
, create
et get
. Vous trouverez ci-dessous les étapes du processus d'association de comptes et le moment où les différents intents sont appelés:
- L'utilisateur a-t-il un compte dans votre système d'authentification ? (L'utilisateur décide en sélectionnant OUI ou NON)
<ph type="x-smartling-placeholder">
- </ph>
- OUI : L'utilisateur se sert-il de l'adresse e-mail associée à son compte Google pour se connecter à votre plate-forme ? (L'utilisateur décide en sélectionnant OUI ou NON)
<ph type="x-smartling-placeholder">
- </ph>
- OUI : L'utilisateur possède-t-il un compte qui correspond dans votre système d'authentification ? (
check intent
est appelé pour confirmer) <ph type="x-smartling-placeholder">- </ph>
- OUI :
get intent
est appelé et le compte est associé si la récupération de l'intent aboutit. - NON : Créer un compte ? (L'utilisateur décide en sélectionnant OUI ou NON)
<ph type="x-smartling-placeholder">
- </ph>
- OUI :
create intent
est appelé et le compte est associé si la création de l'intent aboutit. - NON : le flux Web OAuth est déclenché, l'utilisateur est dirigé vers son navigateur et a la possibilité d'associer son compte à une autre adresse e-mail.
- OUI :
- OUI :
- NON : Le flux Web OAuth est déclenché, l'utilisateur est dirigé vers son navigateur et a la possibilité d'associer son compte à une autre adresse e-mail.
- OUI : L'utilisateur possède-t-il un compte qui correspond dans votre système d'authentification ? (
- NON : L'utilisateur possède-t-il un compte qui correspond dans votre système d'authentification ? (
check intent
est appelé pour confirmer) <ph type="x-smartling-placeholder">- </ph>
- OUI :
get intent
est appelé et le compte est associé si la récupération de l'intent aboutit. - NON :
create intent
est appelé et le compte est associé si la création de l'intent aboutit.
- OUI :
- OUI : L'utilisateur se sert-il de l'adresse e-mail associée à son compte Google pour se connecter à votre plate-forme ? (L'utilisateur décide en sélectionnant OUI ou NON)
<ph type="x-smartling-placeholder">
Check for an existing user account (check intent)
After the user gives consent to access their Google profile, Google sends a request that contains a signed assertion of the Google user's identity. The assertion contains information that includes the user's Google Account ID, name, and email address. The token exchange endpoint configured for your project handles that request.
If the corresponding Google account is already present in your authentication
system, your token exchange endpoint responds with account_found=true
. If the
Google account doesn't match an existing user, your token exchange endpoint
returns an HTTP 404 Not Found error with account_found=false
.
The request has the following form:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=check&assertion=JWT&scope=SCOPES&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET
Your token exchange endpoint must be able to handle the following parameters:
Token endpoint parameters | |
---|---|
intent |
For these requests, the value of this parameter is
check . |
grant_type |
The type of token being exchanged. For these requests, this
parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer . |
assertion |
A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes the user's Google Account ID, name, and email address. |
client_id |
The client ID you assigned to Google. |
client_secret |
The client secret you assigned to Google. |
To respond to the check
intent requests, your token exchange endpoint must perform the following steps:
- Validate and decode the JWT assertion.
- Check if the Google account is already present in your authentication system.
Valider et décoder l'assertion JWT
Vous pouvez valider et décoder l'assertion JWT à l'aide d'un Bibliothèque de décodage JWT pour votre langage. Utilisez Clés publiques de Google, disponibles JWK ou formats PEM, à vérifier la signature du jeton.
Une fois décodée, l'assertion JWT ressemble à l'exemple suivant:
{ "sub": "1234567890", // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "email_verified": true, // true, if Google has verified the email address "hd": "example.com", // If present, the host domain of the user's GSuite email address // If present, a URL to user's profile picture "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ", "locale": "en_US" // User's locale, from browser or phone settings }
En plus de vérifier la signature du jeton, vérifiez que l'assertion
(champ iss
) est https://accounts.google.com
, que l'audience
(champ aud
) correspond à l'ID client qui vous a été attribué et que le jeton n'a pas expiré.
(champ exp
).
À l'aide des champs email
, email_verified
et hd
, vous pouvez déterminer
Google héberge les adresses e-mail et fait autorité pour celles-ci. Dans les cas où Google
faisant autorité, l'utilisateur est actuellement connu comme étant le titulaire légitime du compte
et vous pouvez ignorer le mot de passe
ou d'autres méthodes d'authentification. Sinon, ces méthodes
pour valider le compte avant de l'associer.
Cas dans lesquels Google fait autorité:
email
comporte le suffixe@gmail.com
. Il s'agit d'un compte Gmail.email_verified
est "true" ethd
est défini. Il s'agit d'un compte G Suite.
Les utilisateurs peuvent créer un compte Google sans utiliser Gmail ni G Suite. Quand ?
email
ne contient pas de suffixe @gmail.com
et hd
est absent. Google ne l'est pas.
faisant autorité et un mot de passe ou d'autres
méthodes d'authentification sont recommandés pour
l'utilisateur. email_verified
peut également être défini sur "true", car Google a initialement validé
utilisateur lors de la création du compte Google, quelle que soit la propriété du tiers
compte de messagerie peut avoir changé depuis.
Check if the Google account is already present in your authentication system
Check whether either of the following conditions are true:
- The Google Account ID, found in the assertion's
sub
field, is in your user database. - The email address in the assertion matches a user in your user database.
If either condition is true, the user has already signed up. In that case, return a response like the following:
HTTP/1.1 200 Success Content-Type: application/json;charset=UTF-8 { "account_found":"true", }
If neither the Google Account ID nor the email address specified in the
assertion matches a user in your database, the user hasn't signed up yet. In
this case, your token exchange endpoint needs to reply with a HTTP 404 error
that specifies "account_found": "false"
, as in the following example:
HTTP/1.1 404 Not found Content-Type: application/json;charset=UTF-8 { "account_found":"false", }
Handle automatic linking (get intent)
After the user gives consent to access their Google profile, Google sends a request that contains a signed assertion of the Google user's identity. The assertion contains information that includes the user's Google Account ID, name, and email address. The token exchange endpoint configured for your project handles that request.
If the corresponding Google Account is already present in your authentication
system, your token exchange endpoint returns a token for the user. If the
Google Account doesn't match an existing user, your token exchange endpoint
returns a linking_error
error and optional login_hint
.
The request has the following form:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&scope=SCOPES&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET
Your token exchange endpoint must be able to handle the following parameters:
Token endpoint parameters | |
---|---|
intent |
For these requests, the value of this parameter is get . |
grant_type |
The type of token being exchanged. For these requests, this
parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer . |
assertion |
A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes the user's Google Account ID, name, and email address. |
scope |
Optional: Any scopes that you've configured Google to request from users. |
client_id |
The client ID you assigned to Google. |
client_secret |
The client secret you assigned to Google. |
To respond to the get
intent requests, your token exchange endpoint must perform the following steps:
- Validate and decode the JWT assertion.
- Check if the Google account is already present in your authentication system.
Valider et décoder l'assertion JWT
Vous pouvez valider et décoder l'assertion JWT à l'aide d'un Bibliothèque de décodage JWT pour votre langage. Utilisez Clés publiques de Google, disponibles JWK ou formats PEM, à vérifier la signature du jeton.
Une fois décodée, l'assertion JWT ressemble à l'exemple suivant:
{ "sub": "1234567890", // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "email_verified": true, // true, if Google has verified the email address "hd": "example.com", // If present, the host domain of the user's GSuite email address // If present, a URL to user's profile picture "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ", "locale": "en_US" // User's locale, from browser or phone settings }
En plus de vérifier la signature du jeton, vérifiez que l'assertion
(champ iss
) est https://accounts.google.com
, que l'audience
(champ aud
) correspond à l'ID client qui vous a été attribué et que le jeton n'a pas expiré.
(champ exp
).
À l'aide des champs email
, email_verified
et hd
, vous pouvez déterminer
Google héberge les adresses e-mail et fait autorité pour celles-ci. Dans les cas où Google
faisant autorité, l'utilisateur est actuellement connu comme étant le titulaire légitime du compte
et vous pouvez ignorer le mot de passe
ou d'autres méthodes d'authentification. Sinon, ces méthodes
pour valider le compte avant de l'associer.
Cas dans lesquels Google fait autorité:
email
comporte le suffixe@gmail.com
. Il s'agit d'un compte Gmail.email_verified
est "true" ethd
est défini. Il s'agit d'un compte G Suite.
Les utilisateurs peuvent créer un compte Google sans utiliser Gmail ni G Suite. Quand ?
email
ne contient pas de suffixe @gmail.com
et hd
est absent. Google ne l'est pas.
faisant autorité et un mot de passe ou d'autres
méthodes d'authentification sont recommandés pour
l'utilisateur. email_verified
peut également être défini sur "true", car Google a initialement validé
utilisateur lors de la création du compte Google, quelle que soit la propriété du tiers
compte de messagerie peut avoir changé depuis.
Check if the Google account is already present in your authentication system
Check whether either of the following conditions are true:
- The Google Account ID, found in the assertion's
sub
field, is in your user database. - The email address in the assertion matches a user in your user database.
If an account is found for the user, issue an access token and return the values in a JSON object in the body of your HTTPS response, like in the following example:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
In some cases, account linking based on ID token might fail for the user. If it
does so for any reason, your token exchange endpoint needs to reply with a HTTP
401 error that specifies error=linking_error
, as the following example shows:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"linking_error", "login_hint":"foo@bar.com" }
When Google receives a 401 error response with linking_error
, Google sends
the user to your authorization endpoint with login_hint
as a parameter. The
user completes account linking using the OAuth linking flow in their browser.
Gérer la création de compte via Google Sign-In (créer un intent)
Lorsqu'un utilisateur doit créer un compte sur votre service, Google lui envoie une demande
au point de terminaison de votre échange de jetons qui spécifie intent=create
.
La demande se présente sous la forme suivante:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&assertion=JWT&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET
Le point de terminaison de votre échange de jetons doit pouvoir gérer les paramètres suivants:
Paramètres du point de terminaison du jeton | |
---|---|
intent |
Pour ces requêtes, la valeur de ce paramètre est create . |
grant_type |
Type de jeton échangé. Pour ces requêtes,
a pour valeur urn:ietf:params:oauth:grant-type:jwt-bearer . |
assertion |
Jeton Web JSON (JWT, JSON Web Token) qui fournit une assertion signée du jeton Google l'identité de l'utilisateur. Le jeton JWT contient des informations qui incluent le jeton ID, nom et adresse e-mail du compte Google. |
client_id |
ID client que vous avez attribué à Google. |
client_secret |
Code secret du client que vous avez attribué à Google. |
Le JWT du paramètre assertion
contient l'ID du compte Google de l'utilisateur,
et l'adresse e-mail, que vous pourrez utiliser pour créer un nouveau compte sur votre
Google Cloud.
Pour répondre aux requêtes d'intent create
, le point de terminaison de votre échange de jetons doit procéder comme suit:
- Validez et décodez l'assertion JWT.
- Validez les informations sur l'utilisateur et créez un compte.
Valider et décoder l'assertion JWT
Vous pouvez valider et décoder l'assertion JWT à l'aide d'un Bibliothèque de décodage JWT pour votre langage. Utilisez Clés publiques de Google, disponibles JWK ou formats PEM, à vérifier la signature du jeton.
Une fois décodée, l'assertion JWT ressemble à l'exemple suivant:
{ "sub": "1234567890", // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "email_verified": true, // true, if Google has verified the email address "hd": "example.com", // If present, the host domain of the user's GSuite email address // If present, a URL to user's profile picture "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ", "locale": "en_US" // User's locale, from browser or phone settings }
En plus de vérifier la signature du jeton, vérifiez que l'assertion
(champ iss
) est https://accounts.google.com
, que l'audience
(champ aud
) correspond à l'ID client qui vous a été attribué et que le jeton n'a pas expiré.
(champ exp
).
À l'aide des champs email
, email_verified
et hd
, vous pouvez déterminer
Google héberge les adresses e-mail et fait autorité pour celles-ci. Dans les cas où Google
faisant autorité, l'utilisateur est actuellement connu comme étant le titulaire légitime du compte
et vous pouvez ignorer le mot de passe
ou d'autres méthodes d'authentification. Sinon, ces méthodes
pour valider le compte avant de l'associer.
Cas dans lesquels Google fait autorité:
email
comporte le suffixe@gmail.com
. Il s'agit d'un compte Gmail.email_verified
est "true" ethd
est défini. Il s'agit d'un compte G Suite.
Les utilisateurs peuvent créer un compte Google sans utiliser Gmail ni G Suite. Quand ?
email
ne contient pas de suffixe @gmail.com
et hd
est absent. Google ne l'est pas.
faisant autorité et un mot de passe ou d'autres
méthodes d'authentification sont recommandés pour
l'utilisateur. email_verified
peut également être défini sur "true", car Google a initialement validé
utilisateur lors de la création du compte Google, quelle que soit la propriété du tiers
compte de messagerie peut avoir changé depuis.
Valider les informations sur l'utilisateur et créer un compte
Vérifiez si l'une des conditions suivantes est remplie:
- L'ID de compte Google, qui se trouve dans le champ
sub
de l'assertion, se trouve dans votre compte utilisateur base de données. - L'adresse e-mail indiquée dans l'assertion correspond à un utilisateur de votre base de données utilisateur.
Si l'une des conditions est vraie, invitez l'utilisateur à associer son compte existant
avec son compte Google. Pour ce faire, répondez à la requête avec une erreur HTTP 401.
qui spécifie error=linking_error
et attribue l'adresse e-mail de l'utilisateur comme
login_hint
Voici un exemple de réponse :
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"linking_error", "login_hint":"foo@bar.com" }
Lorsque Google reçoit une réponse d'erreur 401 avec linking_error
, il envoie
l'utilisateur à votre point de terminaison d'autorisation avec login_hint
comme paramètre. La
L'utilisateur effectue l'association du compte à l'aide du flux d'association OAuth dans son navigateur.
Si aucune condition n'est vraie, créez un nouveau compte d'utilisateur avec les informations fournies dans le JWT. En règle générale, aucun mot de passe n'est défini pour les nouveaux comptes. Il est recommandé d'ajouter Google Sign-In aux autres plates-formes pour permettre aux utilisateurs vous connecter à Google sur toutes les surfaces de votre application. Vous pouvez également Vous pouvez envoyer à l'utilisateur un lien qui lancera le processus de récupération de mot de passe pour lui permettre pour définir un mot de passe afin de se connecter sur d'autres plates-formes.
Une fois la création terminée, émettez un jeton d'accès et qui renvoient les valeurs dans un objet JSON le corps de votre réponse HTTPS, comme dans l'exemple suivant:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
Obtenir votre ID client pour les API Google
Vous devrez fournir votre ID client pour l'API Google lors du processus d'enregistrement de l'association de comptes.
Pour obtenir votre ID client d'API à l'aide du projet que vous avez créé au cours de la procédure d'association OAuth, procédez comme suit : Pour ce faire, procédez comme suit :
- Ouvrez la page Identifiants du Console Google APIs
Créez ou sélectionnez un projet d'API Google.
Si votre projet ne dispose pas d'un ID client pour le type d'application Web, cliquez sur Créer des identifiants > ID client OAuth pour en créer un. Veillez à inclure domaine de votre site dans la zone Origines JavaScript autorisées. Lorsque vous effectuez développement ou test en local, vous devez ajouter
http://localhost
ethttp://localhost:<port_number>
dans le champ Origines JavaScript autorisées.
Valider votre implémentation
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.