Associer des comptes avec OAuth et Google Sign-In (Dialogflow)

Le type d'association OAuth et Google Sign-In ajoute Google Sign-In en plus de l'authentification OAuth l'association de comptes. Cela permet aux utilisateurs Google d'effectuer une association par commande vocale de manière fluide. tout en activant l'association de compte pour les utilisateurs qui se sont inscrits à votre service avec une identité autre que Google.

Ce type d'association commence par Google Sign-In, qui vous permet de vérifier si Les informations de profil Google existent dans votre système. Si les informations de l'utilisateur est introuvable dans votre système, un flux OAuth standard démarre. L'utilisateur peut également décident de créer un compte avec les informations de leur profil Google.

<ph type="x-smartling-placeholder">

</ph>

Figure 1: Une fois que votre action a accès au compte Google de l'utilisateur profil, vous pouvez l'utiliser pour trouver une correspondance pour l'utilisateur dans votre système d'authentification.

Pour associer un compte avec OAuth et Google Sign-In, procédez comme suit : étapes:

1. Commencez par demander à l'utilisateur l'autorisation d'accéder à son profil Google.
2. Utilisez les informations de son profil pour identifier l'utilisateur.
3. Si vous ne trouvez pas de correspondance pour l'utilisateur Google dans votre système d'authentification, le flux se déroule selon que vous avez configuré ou non votre projet Actions dans la console Actions pour autoriser la création de comptes utilisateur par commande vocale ou uniquement votre site Web.
   • Si vous autorisez la création de compte par commande vocale, validez l'ID de clé reçu de Google. Vous pouvez ensuite créer un utilisateur informations de profil contenues dans le jeton d'ID.
   • Si vous n'autorisez pas la création de compte par commande vocale, le compte utilisateur est transféré vers un navigateur dans lequel ils peuvent charger votre page d'autorisation et terminer processus de création.

Figure 2. Représentation visuelle des protocoles OAuth et Google Flux de connexion lorsque les informations d'un utilisateur sont introuvables dans votre système.

Permettre la création de comptes par commande vocale

Si vous autorisez la création de comptes utilisateur par commande vocale, l'Assistant demande à l'utilisateur s'il souhaite elle souhaite effectuer les opérations suivantes:

• créer un compte dans votre système à l'aide des informations de son compte Google ; ou
• Se connecter au système d'authentification avec un autre compte s'il dispose d'un un compte autre que Google existant.

Nous vous recommandons d'autoriser la création de compte par commande vocale si vous souhaitez lors du processus de création de compte. Il suffit à l'utilisateur de quitter le flux vocal s'ils veulent se connecter avec un compte autre que Google.

Interdire la création de compte par commande vocale

Si vous avez désactivé la création de compte utilisateur par commande vocale, l'Assistant ouvre l'URL au que vous avez fourni pour l'authentification de l'utilisateur. Si l'interaction a lieu sur un appareil sans écran, l'Assistant redirige l'utilisateur vers un téléphone pour poursuivre le processus d'association de compte.

Il est recommandé d'interdire la création dans les cas suivants:

• Vous ne devez pas autoriser les utilisateurs ne disposant pas de compte Google à créer et souhaitez qu'ils soient associés à leurs comptes d'utilisateurs existants dans votre d'authentification unique. Par exemple, si vous proposez un programme de fidélité, vous pouvez vous assurer que l'utilisateur ne perd pas les points accumulés compte existant.

• Vous devez contrôler entièrement le processus de création de compte. Par exemple, vous pouvez interdisez la création si vous devez présenter vos conditions d'utilisation à l'utilisateur pendant création d'un compte.

Remarque :Sélectionnez l'une des options de flux ci-dessous pour en savoir plus sur l'implémentation de la le flux sélectionné. Si nécessaire, le contenu du guide sera actualisé afin de s'adapter de votre choix.

<ph type="x-smartling-placeholder"></ph> Autoriser la création de comptes par commande vocale Interdire la création de comptes par commande vocale

Implémenter l'association de comptes OAuth et Google Sign-In

Les comptes sont associés à des flux OAuth 2.0 conformes aux normes du secteur. Actions on Google est compatible avec les flux de code implicite et d'autorisation.

Remarque :Si vous implémentez l'association de comptes pour gérer les informations financières, des règles supplémentaires peuvent s'appliquer à votre action. Il peut nous falloir jusqu'à six semaines pour examiner une action avec l'association de compte afin d'obtenir des informations financières. tenez compte de ce temps dans la planification de votre calendrier de publication. Pour faciliter l'examen assurez-vous de respecter les règles relatives aux services financiers avant de soumettre votre action pour examen.

In the implicit code 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 the Assistant to your Action.

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
• 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.

Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.

Note: Please choose which OAuth2 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

Configurer le projet

Configurer votre projet de façon à utiliser un compte OAuth et Google Sign-In procédez comme suit:

1. Ouvrez la console Actions et sélectionnez le projet que vous souhaitez utiliser.
2. Cliquez sur l'onglet Développer, puis sélectionnez Association de comptes.
3. Activez le bouton bascule à côté de l'option Association de comptes.
4. Dans la section Création de compte, sélectionnez Oui.

5. Dans Type d'association, sélectionnez OAuth et Google Sign-In et Implicit.

   

6. Sous Informations sur le client, procédez comme suit:

   • Attribuez une valeur à Numéro client attribué par le programme Actions à Google pour identifier émanent de Google.
   • Insérez les URL de vos points de terminaison Autorisation et Échange de jetons.

7. Cliquez sur Enregistrer.

Implémenter votre serveur OAuth

To support the OAuth 2.0 implicit flow, your service makes an authorization endpoint available by HTTPS. This endpoint is responsible for authenticating and obtaining consent from users for data access. The authorization endpoint presents a sign-in UI to your users that aren't already signed in and records consent to the requested access.

When your Action needs to call one of your service's authorized APIs, Google uses this endpoint to get permission from your users to call these APIs on their behalf.

A typical OAuth 2.0 implicit flow session initiated by Google has the following flow:

1. Google opens your authorization endpoint in the user's browser. The user signs in if not signed in already, and grants Google permission to access their data with your API if they haven't already granted permission.
2. Your service creates an access token and returns it to Google by redirecting the user's browser back to Google with the access token attached to the request.
3. Google calls your service's APIs, and attaches the access token with each request. Your service verifies that the access token grants Google authorization to access the API and then completes the API call.

Handle authorization requests

When your Action needs to perform account linking via an OAuth2 implicit flow, Google sends the user to your authorization endpoint with a request that includes the following parameters:

Authorization endpoint parameters
client_id	The client ID you assigned to Google.
redirect_uri	The URL to which you send the response to this request.
state	A bookkeeping value that is passed back to Google unchanged in the redirect URI.
response_type	The type of value to return in the response. For the OAuth 2.0 implicit flow, the response type is always token.

For example, if your authorization endpoint is available at https://myservice.example.com/auth, a request might look like:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token

For your authorization endpoint to handle sign-in requests, do the following steps:

1. Verify the client_id and redirect_uri values to prevent granting access to unintended or misconfigured client apps:

   • Confirm that the client_id matches the client ID you assigned to Google.
   • Confirm that the URL specified by the redirect_uri parameter has the following form:

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

     YOUR_PROJECT_ID is the ID found on the Project settings page of the Actions Console.

2. Check if the user is signed in to your service. If the user isn't signed in, complete your service's sign-in or sign-up flow.

3. Generate an access token that Google will use to access your API. The access token can be any string value, but it must uniquely represent the user and the client the token is for and must not be guessable.

4. Send an HTTP response that redirects the user's browser to the URL specified by the redirect_uri parameter. Include all of the following parameters in the URL fragment:

   • access_token: the access token you just generated
   • token_type: the string bearer
   • state: the unmodified state value from the original request The following is an example of the resulting URL:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Google's OAuth 2.0 redirect handler will receive the access token and confirm that the state value hasn't changed. After Google has obtained an access token for your service, Google will attach the token to subsequent calls to your Action as part of the AppRequest.

Handle automatic linking

After the user gives your Action 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 user_not_found error.

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&consent_code=CONSENT_CODE&scope=SCOPES

Your token exchange endpoint must be able to handle the following parameters:

Token endpoint parameters
grant_type	The type of token being exchanged. For these requests, this parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer.
intent	For these requests, the value of this parameter is `get`.
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.
consent_code	Optional: When present, a one-time code that indicates that the user has granted consent for your Action to access the specified scopes.
scope	Optional: Any scopes you configured Google to request from users.

When your token exchange endpoint receives the linking request, it should do the following:

Valider et décoder l'assertion JWT

Vous pouvez valider et décoder l'assertion JWT à l'aide d'une bibliothèque de décodage JWT pour votre langage. Utilisez les clés publiques de Google (disponibles dans JWK ou PEM) pour vérifier signature.

Remarque :Les clés ne doivent pas être codées en dur. Suivez plutôt les instructions d'OpenID Connect Discovery protocole et vérifiez l'en-tête cache-control pour déterminer la durée pendant laquelle la clé doit être mise en cache.

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": "[e-mail]", // If present, the user's email address
  "locale": "en_US"
}

En plus de vérifier la signature du jeton, vérifiez que l'émetteur de l'assertion (champ iss) est https://accounts.google.com et que l'audience (champ aud) est l'ID client attribué à votre action.

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 and you can issue an access token.

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 should reply with a HTTP 401 error, that specifies error=user_not_found, as in the following example:

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"user_not_found",
}

When Google receives the 401 error response with a user_not_found error, Google calls your token exchange endpoint with the value of the intent parameter set to create and sending an ID token that contains the user's profile information with the request.

Gérer la création de compte via Google Sign-In

Lorsqu'un utilisateur doit créer un compte sur votre service, Google effectue une à votre point de terminaison d'échange de jetons, qui spécifie intent=create, comme dans l'exemple suivant:

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&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]

Le paramètre assertion contient un jeton Web JSON (JWT) qui fournit une assertion signée de l'identité de l'utilisateur Google. Le jeton JWT contient des informations qui inclut l'ID, le nom et l'adresse e-mail du compte Google de l'utilisateur, que vous pouvez utiliser pour créer un nouveau compte sur votre service.

Pour répondre aux demandes de création de compte, le point de terminaison de votre échange de jetons doit les éléments suivants:

Valider et décoder l'assertion JWT

Vous pouvez valider et décoder l'assertion JWT à l'aide d'une bibliothèque de décodage JWT pour votre langage. Utilisez les clés publiques de Google (disponibles dans JWK ou PEM) pour vérifier signature.

Remarque :Les clés ne doivent pas être codées en dur. Suivez plutôt les instructions d'OpenID Connect Discovery protocole et vérifiez l'en-tête cache-control pour déterminer la durée pendant laquelle la clé doit être mise en cache.

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": "[e-mail]", // If present, the user's email address
  "locale": "en_US"
}

En plus de vérifier la signature du jeton, vérifiez que l'émetteur de l'assertion (champ iss) est https://accounts.google.com et que l'audience (champ aud) est l'ID client attribué à votre action.

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 base de données d'utilisateurs.
• 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 à son compte Google en répondant à la requête avec une erreur HTTP 401, en spécifiant error=linking_error et l'adresse e-mail de l'utilisateur en tant que login_hint, comme dans l'exemple suivant:

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"linking_error",
  "login_hint":"[e-mail]"
}

Si aucune condition n'est remplie, créez un nouveau compte d'utilisateur à l'aide des 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 de se connecter via Google sur toutes les surfaces de votre application. Vous pouvez également envoyer par e-mail à l'utilisateur un lien qui lance le processus de récupération de mot de passe pour lui permettre de définir un mot de passe pour se connecter sur d'autres plateformes.

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
}

Démarrer le flux d'authentification

Avertissement:Ne fournissez pas aux utilisateurs un compte obligatoire associer la requête à votre action au début de la conversation. À la place, fournir aux utilisateurs non authentifiés un flux invité leur permettant de montrer comment fonctionne votre action ; puis ne demandez l'association de comptes que si c'est nécessaire pour continuer. Si les utilisateurs qui quitte l'action de manière cohérente en raison de problèmes d'association de compte, Google ne pas promouvoir activement l'action, ce qui peut réduire le trafic utilisateur de celle-ci ;

Notez que seuls les utilisateurs validés peuvent associer leurs comptes. Si l'utilisateur est un invité, l'association du compte échouera. En savoir plus sur l'identification et la gestion utilisateurs invités.

Utiliser l'intent d'assistance à la connexion au compte pour démarrer le flux d'authentification.

<ph type="x-smartling-placeholder">

</ph> <ph type="x-smartling-placeholder">

</ph>

Dialogflow (Node.js)

const app = dialogflow({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
})

// Intent that starts the account linking flow.
app.intent('Start Signin', conv => {
  conv.ask(new SignIn('To get your account details'))
})

<ph type="x-smartling-placeholder">

</ph>

Dialogflow (Java)

private String clientId = "<your_client_id>";

@ForIntent("Start Signin")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

<ph type="x-smartling-placeholder">

</ph>

SDK Actions (Node.js)

const app = actionssdk({
  clientId: CLIENT_ID,
})

app.intent('Start Signin', conv => {
  conv.ask(new SignIn('To get your account details'))
})

<ph type="x-smartling-placeholder">

</ph>

SDK Actions (Java)

private String clientId = "<your_client_id>";

@ForIntent("actions.intent.TEXT")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

Gérer les requêtes d'accès aux données

Si la requête Assistant contient un jeton d'accès, vérifiez d'abord que le jeton d'accès est valide et qu'il n'a pas expiré, puis récupérez-le la base de données du compte utilisateur le compte utilisateur associé au jeton.