Vinculação de contas com a vinculação "simplificada" do Login do Google com base em OAuth

O tipo de vinculação simplificada do Login do Google com base em OAuth adiciona o Login do Google à vinculação de contas com base em OAuth. Isso fornece vinculação baseada em voz integrada para usuários do Google e, ao mesmo tempo, permite a vinculação de contas para usuários que se registraram no serviço com uma identidade que não é do Google.

Esse tipo de vinculação começa com o Login do Google, que permite verificar se as informações do perfil do Google do usuário existem no seu sistema. Se as informações do usuário não forem encontradas no sistema, um fluxo padrão do OAuth será iniciado. O usuário também pode optar por criar uma nova conta com as informações do perfil do Google dele.

Figura 1: depois que a Ação tiver acesso ao perfil do Google do usuário, use-o para encontrar uma correspondência para o usuário no sistema de autenticação.

Para fazer a vinculação de contas com o tipo de vinculação simplificada, siga estas etapas gerais:

1. Primeiro, peça que o usuário dê consentimento para acessar o perfil do Google.
2. Use as informações no perfil para identificar o usuário.
3. Se não encontrar uma correspondência para o usuário do Google no sistema de autenticação, o fluxo continuará dependendo se você configurou o projeto do Actions no Console do Actions para permitir a criação de contas de usuário por voz ou apenas no seu site.
   • Se você permitir a criação de conta por voz, valide o token de ID recebido do Google. Então, você poderá criar um usuário com base nas informações de perfil contidas no token de ID.
   • Se você não permitir a criação de contas por voz, o usuário será transferido para um navegador em que ele poderá carregar sua página de autorização e concluir o fluxo de criação.

Figura 2. Uma representação visual do fluxo de OAuth e Login do Google quando as informações de um usuário não são encontradas no seu sistema.

Suporte à criação de contas por voz

Se você permitir a criação de contas de usuário por voz, o Google Assistente vai perguntar ao usuário se ele quer fazer o seguinte:

• Criar uma nova conta no seu sistema usando as informações da Conta do Google dele ou
• Faça login no seu sistema de autenticação com uma conta diferente, se ele já tiver uma conta que não seja do Google.

Permitir a criação de contas por voz é recomendado se você quiser minimizar o atrito do fluxo de criação de contas. O usuário só precisa sair do fluxo de voz se quiser fazer login usando uma conta que não seja do Google.

Não permitir a criação de conta por voz

Se você não permitir a criação de contas de usuário por voz, o Google Assistente vai abrir o URL do site fornecido para a autenticação. Se a interação estiver acontecendo em um dispositivo sem tela, o Google Assistente vai direcionar o usuário a um smartphone para continuar o fluxo de vinculação da conta.

É recomendável não permitir a criação se:

• Você não quer permitir que usuários que tenham contas que não sejam do Google criem uma nova conta de usuário e que vinculem as contas de usuário existentes no seu sistema de autenticação. Por exemplo, se você oferecer um programa de fidelidade, convém garantir que o usuário não perca os pontos acumulados na conta atual.

• Você precisa ter controle total do fluxo de criação da conta. Por exemplo, você poderá impedir a criação se precisar mostrar seus Termos de Serviço ao usuário durante a criação da conta.

Observação: selecione uma das opções de fluxo abaixo para saber mais sobre como implementar o fluxo selecionado. Se necessário, o conteúdo do guia vai ser recarregado para se adaptar à sua escolha.

Permitir a criação de contas por voz Não permitir a criação de contas por voz

Implementar a vinculação simplificada do Login do Google com base em OAuth

As contas estão vinculadas aos fluxos do OAuth 2.0 padrão do setor. O Actions on Google oferece suporte aos fluxos implícitos e de código de autorização.

Observação: se você estiver implementando a vinculação de contas para lidar com informações financeiras, outras políticas poderão ser aplicadas à sua Ação. Pode levar até seis semanas para revisar uma Ação com vinculação de conta para informações financeiras. Portanto, considere esse tempo ao planejar a programação de lançamento. Para facilitar o processo de análise, obedeça às políticas de serviços financeiros antes de enviar sua ação para análise.

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

Configurar o projeto

Para configurar seu projeto para usar a vinculação simplificada, siga estas etapas:

1. Abra o Console do Actions e selecione o projeto que você quer usar.
2. Clique na guia Desenvolver e escolha Vinculação de contas.
3. Ative a chave ao lado de Vinculação de contas.
4. Na seção Criação de conta, selecione Sim.

5. Em Tipo de vinculação, selecione OAuth e Login do Google e Implícito.

   

6. Em Informações do cliente, faça o seguinte:

   • Atribua um valor ao ID do cliente emitido pelas suas ações para o Google para identificar solicitações do Google.
   • Insira os URLs dos endpoints de autorização e de troca de tokens.

7. Clique em Salvar.

Implementar o servidor OAuth

为了支持 OAuth 2.0 隐式流程，您的服务会通过 HTTPS 提供授权端点。此端点负责验证数据访问并从用户那里获得同意。授权端点会向尚未登录的用户呈现登录界面，并记录用户同意所请求的访问。

当您的 Action 需要调用某项服务的已授权 API 时，Google 会使用此端点从您的用户处获取权限，以便代表他们调用这些 API。

由 Google 发起的典型 OAuth 2.0 隐式流会话具有以下流程：

1. Google 会在用户的浏览器中打开您的授权端点。用户如果尚未登录，则登录；如果用户尚未授予权限，则授予 Google 使用您的 API 访问其数据的权限。
2. 您的服务会创建访问令牌，并使用附加到请求的访问令牌将用户的浏览器重定向回 Google，从而将其返回给 Google。
3. Google 会调用您的服务的 API，并为每个请求附加访问令牌。您的服务会验证访问令牌是否授予 Google 访问 API 的授权，然后完成 API 调用。

处理授权请求

当您的 Action 需要通过 OAuth 2.0 隐式流程执行帐号关联时，Google 会通过包含以下参数的请求将用户发送到您的授权端点：

授权端点参数
client_id	您分配给 Google 的客户端 ID。
redirect_uri	您要将该请求的响应发送到的网址。
state	在重定向 URI 中原封不动地传回 Google 的簿记值。
response_type	要在响应中返回的值的类型。对于 OAuth 2.0 隐式流程，响应类型始终为 token。

例如，如果您的授权端点位于 https://myservice.example.com/auth，请求可能如下所示：

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

为了让授权端点能够处理登录请求，请执行以下步骤：

1. 验证 client_id 和 redirect_uri 值，以防止授予对意外或配置错误的客户端应用的访问权限：

   • 确认 client_id 与您分配给 Google 的客户端 ID 匹配。
   • 确认 redirect_uri 参数指定的网址采用以下格式：

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

     YOUR_PROJECT_ID 是在 Actions 控制台的 Project settings 页面上找到的 ID。

2. 检查用户是否登录了您的服务。如果用户未登录，请完成服务的登录或注册流程。

3. 生成 Google 将用于访问您的 API 的访问令牌。访问令牌可以是任何字符串值，但它必须唯一地代表用户和令牌所面向的客户端，并且必须不可猜测。

4. 发送 HTTP 响应，将用户浏览器重定向到 redirect_uri 参数指定的网址。在网址片段中添加以下所有参数：

   • access_token：您刚刚生成的访问令牌
   • token_type：字符串 bearer
   • state：原始请求中的未修改状态值 以下是所生成网址的示例：

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

Google 的 OAuth 2.0 重定向处理程序将接收访问令牌，并确认 state 值未更改。Google 为您的服务获取访问令牌后，会将该令牌作为 AppRequest 的一部分附加到对您的 Action 的后续调用。

处理自动关联

用户同意您的 Action 访问其 Google 个人资料后，Google 会发送一个请求，其中包含已签署的 Google 用户身份断言。该断言包含用户的 Google 帐号 ID、姓名和电子邮件地址等信息。您为项目配置的令牌交换端点会处理该请求。

如果您的身份验证系统中已存在相应的 Google 帐号，则令牌交换端点为用户返回一个令牌。如果 Google 帐号与现有用户不匹配，则令牌交换端点会返回 user_not_found 错误。

该请求的格式如下：

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

您的令牌交换端点必须能够处理以下参数：

令牌端点参数
grant_type	要交换的令牌的类型。对于这些请求，此参数的值为 urn:ietf:params:oauth:grant-type:jwt-bearer。
intent	对于这些请求，此参数的值为 `get`。
assertion	一个 JSON Web 令牌 (JWT)，可提供 Google 用户身份的已签名断言。JWT 包含用户的 Google 帐号 ID、名称和电子邮件地址等信息。
consent_code	可选：如果存在，这是一个一次性代码，用于表明用户已同意您的 Action 访问指定范围。
scope	可选：您已配置 Google 向用户请求的任何范围。

当您的令牌交换端点收到关联请求时，应执行以下操作：

验证和解码 JWT 断言

您可以使用适合您的语言的 JWT 解码库来验证和解码 JWT 断言。使用 Google 的公钥（以 JWK 或 PEM 格式提供）来验证令牌的签名。

注意 ：键不应采用硬编码。而应按照 OpenID connect Discovery Protocol 并检查 cache-control 标头，以确定应将密钥缓存多长时间。

解码后，JWT 断言如下所示：

{
  "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"
}

除了验证令牌的签名之外，请验证断言的颁发者（iss 字段）是否为 https://accounts.google.com，以及目标对象群组（aud 字段）是否为分配给您的 Action 的客户端 ID。

检查您的身份验证系统中是否已经存在相关 Google 账号

检查是否满足以下任一条件：

• Google 帐号 ID（可在断言的 sub 字段中找到）位于您的用户数据库中。
• 断言中的电子邮件地址与用户数据库中的用户匹配。

如果满足任一条件，则表示用户已完成注册，您可以颁发访问令牌。

如果 Google 帐号 ID 和断言中指定的电子邮件地址均与您数据库中的用户不匹配，则表示该用户尚未注册。在这种情况下，您的令牌交换端点应回复 HTTP 401 错误，该错误会指定 error=user_not_found，如以下示例所示：

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

{
  "error":"user_not_found",
}

当 Google 收到包含 user_not_found 错误的 401 错误响应时，Google 会调用您的令牌交换端点，将 intent 参数的值设为 create，并通过请求发送一个包含用户个人资料信息的 ID 令牌。

通过 Google 登录功能处理账号创建

当用户需要在您的服务上创建帐号时，Google 会向您的令牌交换端点发出一个指定 intent=create 的请求，如以下示例所示：

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]

assertion 参数包含一个 JSON 网络令牌 (JWT)，该令牌提供了 Google 用户身份的已签名断言。JWT 包含用户的 Google 帐号 ID、姓名和电子邮件地址等信息，您可以使用这些信息在您的服务上创建新帐号。

为了响应帐号创建请求，您的令牌交换端点必须执行以下操作：

验证和解码 JWT 断言

您可以使用适合您的语言的 JWT 解码库来验证和解码 JWT 断言。使用 Google 的公钥（以 JWK 或 PEM 格式提供）来验证令牌的签名。

注意 ：键不应采用硬编码。而应按照 OpenID connect Discovery Protocol 并检查 cache-control 标头，以确定应将密钥缓存多长时间。

解码后，JWT 断言如下所示：

{
  "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"
}

除了验证令牌的签名之外，请验证断言的颁发者（iss 字段）是否为 https://accounts.google.com，以及目标对象群组（aud 字段）是否为分配给您的 Action 的客户端 ID。

验证用户信息并创建新账号

检查是否满足以下任一条件：

• Google 帐号 ID（可在断言的 sub 字段中找到）位于您的用户数据库中。
• 断言中的电子邮件地址与用户数据库中的用户匹配。

如果满足上述任一条件，请提示用户通过 HTTP 401 错误响应请求，将 error=linking_error 和用户的电子邮件地址指定为 login_hint，从而将其现有帐号与其 Google 帐号相关联，如以下示例所示：

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

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

如果两个条件都不满足，则使用 JWT 中提供的信息创建新的用户帐号。新帐号通常不会设置密码。建议您将 Google 登录功能添加到其他平台，让用户能够在应用的各种途径中通过 Google 登录。或者，您也可以通过电子邮件向用户发送用于启动密码恢复流程的链接，以便用户设置用于在其他平台上登录的密码。

创建完成后，发出访问令牌 ，然后返回 HTTPS 响应正文中 JSON 对象中的值，如以下示例所示：

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

Projetar a interface do usuário de voz para o fluxo de autenticação

Aviso:não forneça um aviso obrigatório de vinculação de conta aos usuários no início da conversa com a ação. Em vez disso, forneça um fluxo de convidado aos usuários não autenticados para mostrar como a ação funciona e só peça a vinculação de conta se for necessária para prosseguir. Se os usuários estiverem saindo da ação de forma consistente devido a problemas de vinculação de conta, o Google não vai promover a ação ativamente, o que pode diminuir o tráfego de usuários.

Observação: use o Actions Builder para criar uma ação que implemente a vinculação de contas.

Conferir se o usuário foi verificado e iniciar o fluxo de vinculação da conta

1. Abra seu projeto do Actions Builder no Actions Console.
2. Crie um novo cenário para começar a vinculação da conta na sua Ação:
   1. Clique em Cenas.
   2. Clique no ícone add (+) para adicionar uma nova cena.
3. No cenário recém-criado, clique no ícone de adição para Condições.
4. Adicione uma condição que verifica se o usuário associado à conversa é um usuário verificado. Se a verificação falhar, a Ação não poderá fazer a vinculação da conta durante a conversa e vai voltar a fornecer acesso a recursos que não exijam a vinculação de conta.
   1. No campo Enter new expression em Condição, insira a seguinte lógica: user.verificationStatus != "VERIFIED"
   2. Em Transição, selecione uma cena que não exija vinculação de conta ou uma cena que seja o ponto de entrada para a funcionalidade exclusiva para convidados.

1. Clique no ícone de adição para Condições.
2. Adicione uma condição para acionar um fluxo de vinculação de conta se o usuário não tiver uma identidade associada.
   1. No campo Enter new expression em Condição, insira a seguinte lógica: user.verificationStatus == "VERIFIED"
   2. Em Transição, selecione a cena do sistema Vinculação de contas.
   3. Clique em Salvar.

Depois de salvar, uma nova cena do sistema de vinculação de contas chamada <SceneName>_AccountLinking será adicionada ao projeto.

Personalizar o cenário de vinculação da conta

1. Em Scenes, selecione a cena do sistema de vinculação de contas.
2. Clique em Enviar solicitação e adicione uma frase curta para descrever ao usuário por que a ação precisa acessar a identidade dele (por exemplo, "Para salvar suas preferências").
3. Clique em Salvar.

1. Em Condições, clique em Se o usuário concluir a vinculação da conta.
2. Configure como o fluxo deve proceder se o usuário concordar em vincular a conta. Por exemplo, chame o webhook para processar qualquer lógica de negócios personalizada necessária e fazer a transição de volta para a cena de origem.
3. Clique em Salvar.

1. Em Condições, clique em Se o usuário cancelar ou dispensar a vinculação da conta.
2. Configure como o fluxo deve proceder se o usuário não concordar em vincular a conta. Por exemplo, envie uma mensagem de confirmação e redirecione para cenas que fornecem funcionalidades que não exigem vinculação de conta.
3. Clique em Salvar.

1. Em Condições, clique em Se ocorrer um erro de sistema ou rede.
2. Configure como o fluxo vai proceder se não for possível concluir o fluxo de vinculação da conta devido a erros no sistema ou na rede. Por exemplo, envie uma mensagem de confirmação e redirecione para cenas que fornecem funcionalidades que não exigem vinculação de conta.
3. Clique em Salvar.

Processar solicitações de acesso a dados

Se a solicitação do Google Assistente contiver um token de acesso, verifique primeiro se o token de acesso é válido e não expirou. Em seguida, recupere a conta do usuário associada ao token no banco de dados da conta de usuário.