Associer des comptes avec OAuth

Le type d'association OAuth est compatible avec deux flux OAuth 2.0 standards dans l'industrie, les flux de code implicite et autorisation.

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 OAuth 2.0 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

Implémenter l'association de compte OAuth

Remarque :Si vous implémentez l'association de comptes pour gérer des informations financières, notez que des règles supplémentaires peuvent s'appliquer à votre action. Nous pouvons mettre jusqu'à six semaines pour examiner une action avec association de comptes pour obtenir des informations financières. Tenez-en compte lorsque vous planifiez votre calendrier de mise en ligne. Pour faciliter le processus d'examen, assurez-vous de respecter les Règles pour les services financiers avant d'envoyer votre action pour examen.

Configurer le projet

Pour configurer votre projet afin d'utiliser l'association OAuth, 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 Association de comptes.
4. Dans la section Création de compte, sélectionnez Non, je souhaite uniquement autoriser la création de comptes sur mon site Web.

5. Dans Type d'association, sélectionnez OAuth et Implicit.

   

6. Dans Informations client:

   • Attribuez une valeur au Client-ID émis par vos actions vers Google pour identifier les requêtes provenant de Google.
   • Insérez les URL de vos points de terminaison Autorisation et Token Exchange.

Remarque :Si vous souhaitez que votre ID client soit envoyé sous forme de chaîne encodée en base64, cliquez sur la flèche du menu déroulant à côté de Configurer votre client (facultatif), puis cochez la case Google pour transmettre l'ID client et le secret via l'en-tête d'authentification de base HTTP.

6. 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 OAuth 2.0 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.

Concevoir l'interface utilisateur vocale pour le flux d'authentification

Avertissement:Ne donnez pas aux utilisateurs une invite d'association de compte obligatoire au début de la conversation avec votre action. Fournissez plutôt aux utilisateurs non authentifiés un flux invité leur indiquant comment fonctionne votre action, puis demandez une association de compte uniquement si cela est nécessaire pour continuer. Si les utilisateurs quittent l'action systématiquement en raison de problèmes d'association de comptes, Google ne la promouvoira pas activement, ce qui peut réduire le trafic utilisateur associé.

Remarque :Vous devez utiliser Actions Builder pour créer une action qui implémente l'association de comptes.

Vérifier si l'utilisateur est validé et démarrer le flux d'association de compte

1. Ouvrez votre projet Actions Builder dans la console Actions.
2. Créez une scène pour lancer l'association de comptes dans votre action :
   1. Cliquez sur Scenes (Scènes).
   2. Cliquez sur l'icône d'ajout (+) pour ajouter une scène.
3. Dans la scène que vous venez de créer, cliquez sur l'icône d'ajout pour Conditions.
4. Ajoutez une condition qui vérifie si l'utilisateur associé à la conversation est un utilisateur validé. Si la vérification échoue, votre action ne peut pas associer de compte pendant la conversation. Elle doit alors fournir l'accès à des fonctionnalités qui ne nécessitent pas d'association de compte.
   1. Dans le champ Enter new expression, sous Condition, saisissez la logique suivante : user.verificationStatus != "VERIFIED"
   2. Sous Transition, sélectionnez une scène ne nécessitant pas d'association de compte ou une scène qui est le point d'entrée de la fonctionnalité Invité.

1. Cliquez sur l'icône d'ajout pour Conditions.
2. Ajoutez une condition pour déclencher un flux d'association de compte si l'utilisateur n'est associé à aucune identité.
   1. Dans le champ Enter new expression, sous Condition, saisissez la logique suivante : user.verificationStatus == "VERIFIED"
   2. Sous Transition, sélectionnez la scène système Association de comptes.
   3. Cliquez sur Enregistrer.

Après l'enregistrement, une nouvelle scène système d'association de comptes appelée <SceneName>_AccountLinking est ajoutée à votre projet.

Personnaliser la scène de l'association de comptes

1. Sous Scenes (Scènes), sélectionnez la scène du système d'association de comptes.
2. Cliquez sur Envoyer une invite et ajoutez une courte phrase pour expliquer à l'utilisateur pourquoi l'action doit accéder à son identité (par exemple, "Enregistrer vos préférences").
3. Cliquez sur Enregistrer.

1. Sous Conditions, cliquez sur Si l'utilisateur a correctement associé ses comptes.
2. Configurez le déroulement du flux si l'utilisateur accepte d'associer son compte. Par exemple, appelez le webhook pour traiter toute logique métier personnalisée requise et revenir à la scène d'origine.
3. Cliquez sur Enregistrer.

1. Sous Conditions, cliquez sur Si l'utilisateur annule ou ignore l'association de comptes.
2. Configurez le déroulement du flux si l'utilisateur n'accepte pas d'associer son compte. Par exemple, envoyez un message de confirmation et redirigez vers des scènes qui fournissent des fonctionnalités qui ne nécessitent pas d'association de compte.
3. Cliquez sur Enregistrer.

1. Sous Conditions, cliquez sur Si une erreur système ou réseau se produit.
2. Configurez la manière dont le flux doit se dérouler si le flux d'association de comptes ne peut pas être terminé en raison d'erreurs système ou réseau. Par exemple, envoyez un message de confirmation et redirigez vers des scènes qui fournissent des fonctionnalités qui ne nécessitent pas d'association de compte.
3. Cliquez sur Enregistrer.

Gérer les demandes d'accès aux données

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