Associer un compte avec OAuth (Dialogflow)

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

Dans le flux de code implicite, Google ouvre votre point de terminaison d'autorisation dans le navigateur de l'utilisateur. Une fois connecté, 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 à l'action par l'Assistant.

Dans le flux de code d'autorisation, vous avez besoin de deux points de terminaison:

• Le point de terminaison authorization, qui consiste à présenter l'interface de connexion aux utilisateurs qui ne sont pas déjà connectés et à enregistrer le consentement demandé pour l'accès demandé sous la forme d'un code d'autorisation temporaire.
• Le point de terminaison d'échange de jetons, responsable de deux types d'échanges :
  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 la procédure 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é.

Bien que le flux de code implicite soit plus facile à mettre en œuvre, Google recommande que les jetons d'accès émis à l'aide du flux implicite n'expirent jamais, car l'expiration du jeton avec le flux implicite oblige l'utilisateur à associer de nouveau son compte. Si vous avez besoin d'un jeton expiré pour des raisons de sécurité, envisagez plutôt d'utiliser le flux de code d'autorisation.

Remarque :Veuillez choisir le flux OAuth2 que vous souhaitez implémenter. Si nécessaire, le contenu de ce guide est actualisé en fonction de votre choix.

Code d'autorisation Flux implicite

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 de compte 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

Pour assurer la compatibilité avec le flux implicite OAuth 2.0, votre service rend un point de terminaison d'autorisation disponible via HTTPS. Ce point de terminaison est responsable de l'authentification et de l'obtention du consentement des utilisateurs pour l'accès aux données. Le point de terminaison d'autorisation présente une UI de connexion aux utilisateurs qui ne sont pas déjà connectés et enregistre leur consentement pour l'accès demandé.

Lorsque votre action doit appeler l'une des API autorisées de votre service, Google utilise ce point de terminaison pour obtenir l'autorisation de vos utilisateurs d'appeler ces API en leur nom.

Une session de flux implicite OAuth 2.0 type lancée par Google se présente comme suit:

1. Google ouvre votre point de terminaison d'autorisation dans le navigateur de l'utilisateur. L'utilisateur se connecte s'il n'est pas déjà connecté et autorise Google à accéder à ses données avec votre API si ce n'est pas déjà fait.
2. Votre service crée un jeton d'accès et le renvoie à Google en redirigeant le navigateur de l'utilisateur vers Google à l'aide du jeton d'accès associé à la requête.
3. Google appelle les API de votre service et associe le jeton d'accès à chaque requête. Votre service vérifie que le jeton d'accès accorde l'autorisation à Google d'accéder à l'API, puis termine l'appel d'API.

Gérer les requêtes d'autorisation

Lorsque votre action doit effectuer l'association de comptes via un flux implicite OAuth2, Google redirige l'utilisateur vers votre point de terminaison d'autorisation avec une requête incluant les paramètres suivants:

Paramètres du point de terminaison d'autorisation
client_id	ID client que vous avez attribué à Google.
redirect_uri	URL à laquelle vous envoyez la réponse à cette requête.
state	Valeur comptable renvoyée à Google telle quelle dans l'URI de redirection.
response_type	Type de valeur à renvoyer dans la réponse. Pour le flux implicite OAuth 2.0, le type de réponse est toujours token.

Par exemple, si votre point de terminaison d'autorisation est disponible à l'adresse 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&response_type=token

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

1. Vérifiez les valeurs client_id et redirect_uri pour éviter d'accorder l'accès à des applications clientes non intentionnelles ou mal configurées:

   • Vérifiez que client_id correspond à l'ID client que vous avez attribué à Google.
   • Vérifiez que l'URL spécifiée par le paramètre redirect_uri présente le format suivant :

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

     YOUR_PROJECT_ID correspond à l'ID figurant sur la page Paramètres du projet de la console Actions.

2. Vérifiez si l'utilisateur est connecté à votre service. Si l'utilisateur n'est pas connecté, suivez la procédure de connexion ou d'inscription à votre service.

3. Générez un jeton d'accès que Google utilisera pour accéder à votre API. Le jeton d'accès peut correspondre à n'importe quelle valeur de chaîne, mais il doit représenter de manière unique l'utilisateur et le client auxquels le jeton est destiné, et ne doit pas être devinable.

4. Envoyez une réponse HTTP qui redirige le navigateur de l'utilisateur vers l'URL spécifiée par le paramètre redirect_uri. Incluez tous les paramètres suivants dans le fragment d'URL:

   • access_token: jeton d'accès que vous venez de générer.
   • token_type: chaîne bearer
   • state: valeur d'état non modifiée de la requête d'origine. Voici un exemple de l'URL obtenue :

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

Le gestionnaire de redirection OAuth 2.0 de Google reçoit le jeton d'accès et confirme que la valeur state n'a pas changé. Une fois que Google a obtenu un jeton d'accès pour votre service, il l'associe aux appels suivants à votre action dans le cadre d'AppRequest.

Démarrer 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 montrant le fonctionnement de votre action, puis demandez l'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é.

Utilisez l'intent d'assistance pour la connexion au compte pour démarrer le flux d'authentification. Les extraits de code suivants décrivent comment envoyer une réponse dans Dialogflow et le SDK Actions pour utiliser cet outil d'aide.

Dialogflow:

Node.js

const {dialogflow, SignIn} = require('actions-on-google');
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'));
});

Java

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

JSON

{
  "payload": {
    "google": {
      "expectUserResponse": true,
      "richResponse": {
        "items": [
          {
            "simpleResponse": {
              "textToSpeech": "PLACEHOLDER"
            }
          }
        ]
      },
      "userStorage": "{\"data\":{}}",
      "systemIntent": {
        "intent": "actions.intent.SIGN_IN",
        "data": {
          "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec",
          "optContext": "To get your account details"
        }
      }
    }
  },
  "outputContexts": [
    {
      "name": "/contexts/_actions_on_google",
      "lifespanCount": 99,
      "parameters": {
        "data": "{}"
      }
    }
  ]
}

SDK Actions:

Node.js

const {actionssdk, SignIn} = require('actions-on-google');
const app = actionssdk({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
});
// Intent that starts the account linking flow.
app.intent('actions.intent.TEXT', (conv) => {
  conv.ask(new SignIn('To get your account details'));
});

Java

@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();
}

JSON

{
  "expectUserResponse": true,
  "expectedInputs": [
    {
      "inputPrompt": {
        "richInitialPrompt": {
          "items": [
            {
              "simpleResponse": {
                "textToSpeech": "PLACEHOLDER"
              }
            }
          ]
        }
      },
      "possibleIntents": [
        {
          "intent": "actions.intent.SIGN_IN",
          "inputValueData": {
            "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec",
            "optContext": "To get your account details"
          }
        }
      ]
    }
  ],
  "conversationToken": "{\"data\":{}}",
  "userStorage": "{\"data\":{}}"
}

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.