El tipo de vinculación "optimizada" del Acceso con Google basado en OAuth agrega el Acceso con Google a la vinculación de cuentas basada en OAuth. Esto proporciona una vinculación basada en voz sin interrupciones para los usuarios de Google y, al mismo tiempo, habilita la vinculación de cuentas para usuarios que se registraron en tu servicio con una identidad ajena a Google.
Este tipo de vinculación comienza con el Acceso con Google, que te permite verificar si la información de perfil de Google del usuario existe en tu sistema. Si no se encuentra la información del usuario en tu sistema, se iniciará un flujo de OAuth estándar. El usuario también puede elegir crear una cuenta nueva con la información de su perfil de Google.
Para vincular una cuenta con el tipo de vinculación optimizada, sigue estos pasos generales:
- En primer lugar, pídele al usuario que otorgue su consentimiento para acceder a su perfil de Google.
- Utilizar la información de su perfil para identificar al usuario
- Si no puedes encontrar una coincidencia para el usuario de Google en tu sistema de autenticación, el flujo continúa dependiendo de si configuraste tu proyecto de acciones en la Consola de Actions para permitir la creación de cuentas de usuario con la voz o solo en tu sitio web.
- Si permites la creación de cuentas por voz, valida el token de ID que recibiste de Google. Luego, puedes crear un usuario según la información de perfil que contiene el token de ID.
- Si no permites la creación de cuentas por voz, el usuario se transfiere a un navegador en el que puede cargar tu página de autorización y completar el flujo de creación de usuarios.
Cómo admitir la creación de cuentas mediante la voz
Si permites la creación de cuentas de usuario por voz, Asistente le preguntará al usuario si desea hacer lo siguiente:
- Crear una cuenta nueva en el sistema con la información de la Cuenta de Google
- Accede al sistema de autenticación con una cuenta diferente si ya tiene una Cuenta que no es de Google.
Se recomienda permitir la creación de cuentas mediante la voz si deseas minimizar los inconvenientes del flujo de creación de cuentas. El usuario solo debe abandonar el flujo de voz si quiere acceder con una cuenta existente que no sea de Google.
No permitir la creación de cuentas con la voz
Si inhabilitaste la creación de cuentas de usuario a través de la voz, Asistente abrirá la URL al sitio web que proporcionaste para la autenticación del usuario. Si la interacción ocurre en un dispositivo que no tiene pantalla, Asistente dirigirá al usuario a un teléfono para continuar con el flujo de vinculación de cuentas.
Se recomienda no permitir la creación en los siguientes casos:
No quieres permitir que los usuarios que tienen cuentas ajenas a Google creen una cuenta de usuario nueva y quieres que se vinculen a sus cuentas de usuario existentes en tu sistema de autenticación. Por ejemplo, si ofreces un programa de lealtad, es posible que quieras asegurarte de que el usuario no pierda los puntos acumulados en su cuenta existente.
Debes tener el control total del flujo de creación de cuentas. Por ejemplo, puedes inhabilitar la creación si necesitas mostrarle tus Condiciones del Servicio al usuario durante el proceso.
Implementa la vinculación "optimizada" del Acceso con Google basado en OAuth
Las cuentas están vinculadas con los flujos OAuth 2.0 estándares de la industria. Actions on Google admite los flujos de código implícito y de autorización.
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:
- 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.
- 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.
Configura el proyecto
Si deseas configurar tu proyecto para que use la vinculación optimizada, sigue estos pasos:
- Abre la Consola de Actions y selecciona el proyecto que deseas usar.
- Haz clic en la pestaña Desarrollo y selecciona Vinculación de cuentas.
- Habilita el interruptor junto a Vinculación de cuentas.
- En la sección Creación de cuenta, selecciona Sí.
En Tipo de vinculación, selecciona Implícito y OAuth y Acceso con Google.
En Información del cliente, haz lo siguiente:
- Asigna un valor al ID de cliente emitido por tus acciones a Google para identificar las solicitudes que provienen de Google.
- Inserta las URL para tus extremos de autorización y de intercambio de tokens.
Haz clic en Guardar.
Implementa tu servidor OAuth
Para admitir el flujo implícito de OAuth 2.0, tu servicio hace una autorización de destino disponible a través de HTTPS. Este extremo es responsable de autenticar y obtener el consentimiento de los usuarios para acceder a los datos. El extremo de autorización presenta una IU de acceso a los usuarios que aún no accedieron y registra el acceso solicitado.
Cuando tu acción necesita llamar a una de las APIs autorizadas de tu servicio, Google usa este extremo para obtener permiso de los usuarios para llamar a estas APIs en sus nombre.
Una sesión típica de flujo implícito de OAuth 2.0 que inicia Google tiene la siguiente flujo:
- Google abre el extremo de autorización en el navegador del usuario. El el usuario accede a la cuenta si aún no lo ha hecho y le concede a Google permiso para acceder sus datos con tu API si aún no han otorgado permiso.
- Tu servicio crea un token de acceso y lo devuelve a Google redireccionando el navegador del usuario de vuelta a Google con el token de acceso que se adjuntan a la solicitud.
- Google llama a las APIs de tu servicio y adjunta el token de acceso con cada solicitud. Tu servicio verifica que el token de acceso otorgue a Google autorización para acceder a la API y, luego, completa la llamada a la API.
Maneja solicitudes de autorización
Cuando tu acción necesite vincular cuentas mediante un flujo implícito de OAuth 2.0, Google envía al usuario a tu extremo de autorización con una solicitud que incluye los siguientes parámetros:
Parámetros del extremo de autorización | |
---|---|
client_id |
El ID de cliente que le asignaste a Google |
redirect_uri |
La URL a la que envías la respuesta a esta solicitud. |
state |
Un valor de contabilidad que se devuelve a Google sin modificar en el URI de redireccionamiento. |
response_type |
Es el tipo de valor que se debe mostrar en la respuesta. Para el OAuth 2.0 implícito
el tipo de respuesta siempre es token . |
Por ejemplo, si tu extremo de autorización está disponible en https://myservice.example.com/auth
,
una solicitud podría verse así:
GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token
Para que tu extremo de autorización controle las solicitudes de acceso, sigue estos pasos:
Verifica los valores
client_id
yredirect_uri
para evita que se otorgue acceso a apps cliente no deseadas o configuradas incorrectamente:- Confirma que
client_id
coincida con el ID de cliente que asignados a Google. - Confirma que la URL especificada por
redirect_uri
tiene la siguiente forma:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
YOUR_PROJECT_ID es el ID que se encuentra en la página Configuración del proyecto de la Consola de Actions.
- Confirma que
Verifica si el usuario accedió a tu servicio. Si el usuario no está firmado completa el flujo de acceso o registro del servicio.
Genera un token de acceso que Google usará para acceder a tu API. El el token de acceso puede ser cualquier valor de cadena, pero debe representar de forma única usuario y cliente para el que es el token y no se debe poder adivinar.
Envía una respuesta HTTP que redirecciona el navegador del usuario a la URL especificadas por el parámetro
redirect_uri
. Incluye todos los siguientes parámetros en el fragmento de URL:access_token
: Es el token de acceso que acabas de generar.token_type
: Es la cadenabearer
.state
: Es el valor del estado sin modificar del original. solicitud El siguiente es un ejemplo de la URL resultante:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING
El controlador de redireccionamiento de OAuth 2.0 de Google recibirá el token de acceso y confirmará
que el valor de state
no haya cambiado. Después de que Google obtiene una
token de acceso para tu servicio, Google adjuntará el token a las llamadas posteriores
a tu acción como parte de AppRequest.
Administra la vinculación automática
Una vez que el usuario otorga tu consentimiento para que la Acción acceda a su perfil de Google, Google envía una solicitud que contiene una aserción firmada de la identidad del usuario de Google. La aserción contiene información que incluye el ID de la Cuenta de Google, el nombre y la dirección de correo electrónico. El extremo de intercambio de tokens configurado para tu proyecto controla a la solicitud.
Si la Cuenta de Google correspondiente ya está presente en tu sistema de autenticación, haz lo siguiente:
el extremo de intercambio de tokens devuelve un token al usuario. Si la Cuenta de Google no
coincide con un usuario existente, tu extremo de intercambio de tokens mostrará un error user_not_found
.
La solicitud tiene el siguiente formato:
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
El extremo de intercambio de tokens debe ser capaz de controlar los siguientes parámetros:
Parámetros de extremo del token | |
---|---|
grant_type |
El tipo de token que se intercambia. Para estas solicitudes, este
tiene el valor urn:ietf:params:oauth:grant-type:jwt-bearer . |
intent |
Para estas solicitudes, el valor de este parámetro es `get`. |
assertion |
Un token web JSON (JWT) que proporciona una aserción firmada del token de Google la identidad del usuario. El JWT contiene información que incluye el ID de Google ID, nombre y dirección de correo electrónico de la cuenta. |
consent_code |
Opcional: Si está presente, es un código único que indica El usuario otorgó su consentimiento para que tu Acción acceda a los permisos especificados. |
scope |
Opcional: Cualquier alcance que hayas configurado Google para que solicite a los usuarios. |
Cuando el extremo de intercambio de tokens recibe la solicitud de vinculación, debe hacer lo siguiente: lo siguiente:
Valida y decodifica la aserción de JWT
Puedes validar y decodificar la aserción de JWT con una biblioteca de decodificación de JWT para tu lenguaje. Usa las claves públicas de Google (disponibles en JWK o PEM) para verificar el firma.
Cuando se decodifica, la aserción de JWT luce como el siguiente ejemplo:
{ "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 "locale": "en_US" }
Además de verificar la firma del token, verifica que el emisor de la aserción
(iss
campo) es https://accounts.google.com
y que el público (campo aud
)
es el ID de cliente asignado a tu acción.
Verifica si la Cuenta de Google ya está presente en tu sistema de autenticación
Verifica si se cumple alguna de las siguientes condiciones:
- El ID de la Cuenta de Google, que se encuentra en el campo
sub
de la aserción, está en tu base de datos de usuarios. - La dirección de correo electrónico en la aserción coincide con un usuario de tu base de datos de usuarios.
Si se cumple alguna de estas condiciones, el usuario ya se registró y puedes emitir una token de acceso.
Si no aparece el ID de la Cuenta de Google ni la dirección de correo electrónico especificada en la aserción
coincide con un usuario de tu base de datos, significa que el usuario aún no se registró. En este caso, tu
el extremo de intercambio del token debe responder con un error HTTP 401, que especifica error=user_not_found
,
como en el siguiente ejemplo:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"user_not_found", }Cuando Google recibe la respuesta de error 401 con un error
user_not_found
,
llama a tu extremo de intercambio de tokens con el valor del parámetro intent
.
Configurar como create y enviar un token de ID que contenga la información de perfil del usuario
con la solicitud.
Controla la creación de cuentas mediante el Acceso con Google
Cuando un usuario necesita crear una cuenta en tu servicio, Google crea
al extremo de intercambio de tokens que especifique
intent=create
, como en el siguiente ejemplo:
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]
El parámetro assertion
contiene un token web JSON (JWT) que proporciona
una aserción firmada
de la identidad del usuario de Google. El JWT contiene información
que incluye el ID de la Cuenta de Google, el nombre y la dirección de correo electrónico del usuario, que puedes usar
para crear una cuenta nueva en tu servicio.
Para responder a las solicitudes de creación de cuentas, el extremo de intercambio de tokens debe hacer lo siguiente:
Valida y decodifica la aserción de JWT
Puedes validar y decodificar la aserción de JWT con una biblioteca de decodificación de JWT para tu lenguaje. Usa las claves públicas de Google (disponibles en JWK o PEM) para verificar el firma.
Cuando se decodifica, la aserción de JWT luce como el siguiente ejemplo:
{ "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 "locale": "en_US" }
Además de verificar la firma del token, verifica que el emisor de la aserción
(iss
campo) es https://accounts.google.com
y que el público (campo aud
)
es el ID de cliente asignado a tu acción.
Validar la información del usuario y crear una cuenta nueva
Verifica si se cumple alguna de las siguientes condiciones:
- El ID de la Cuenta de Google, que se encuentra en el campo
sub
de la aserción, está en tu base de datos de usuarios. - La dirección de correo electrónico en la aserción coincide con un usuario de tu base de datos de usuarios.
Si se cumple alguna de estas condiciones, solicita al usuario que vincule su cuenta existente con
su Cuenta de Google respondiendo a la solicitud con un error HTTP 401 y especificando
error=linking_error
y la dirección de correo electrónico del usuario como login_hint
, como en el
siguiente ejemplo:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"linking_error", "login_hint":"foo@bar.com" }
Si ninguna condición es verdadera, crea una nueva cuenta de usuario con la información. proporcionadas en el JWT. Las cuentas nuevas no suelen tener una contraseña establecida. Sí se recomendó agregar Acceso con Google a otras plataformas para permitir que los usuarios accedan a través de Google en todas las plataformas de tu aplicación. Como alternativa, puedes enviar por correo electrónico al usuario un vínculo que inicie el flujo de recuperación de contraseña para permitirle configurar una contraseña para acceder en otras plataformas.
Cuando se complete la creación, emite un token de acceso y se mostrarán los valores de un objeto JSON en el cuerpo de la respuesta HTTPS, como en el siguiente ejemplo:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
Diseñar la interfaz de usuario de voz para el flujo de autenticación
Comprueba si el usuario está verificado y comienza el flujo de vinculación de cuentas
- Abre tu proyecto de Actions Builder en la Consola de Actions.
- Crea una escena nueva para comenzar a vincular cuentas en tu acción:
- Haz clic en Scenes.
- Haz clic en el ícono de agregar (+) para agregar una escena nueva.
- En la escena recién creada, haz clic en el ícono de agregar add para Conditions.
- Agrega una condición que verifique si el usuario asociado con la conversación es un usuario verificado. Si la verificación falla, tu Acción no podrá realizar la vinculación de cuentas durante la conversación y debería volver a proporcionar acceso a la funcionalidad que no requiera la vinculación de cuentas.
- En el campo
Enter new expression
, en Condición, ingresa la siguiente lógica:user.verificationStatus != "VERIFIED"
- En Transición, selecciona una escena que no requiera la vinculación de una cuenta o una que sea el punto de entrada a la funcionalidad solo para invitados.
- En el campo
- Haz clic en el ícono de agregar add para Conditions.
- Agrega una condición para activar un flujo de vinculación de cuentas si el usuario no tiene una identidad asociada.
- En el campo
Enter new expression
, en Condición, ingresa la siguiente lógica:user.verificationStatus == "VERIFIED"
- En Transition, selecciona la escena del sistema Account Linking.
- Haz clic en Guardar.
- En el campo
Después de guardar, se agrega a tu proyecto una nueva escena del sistema de vinculación de cuentas llamada <SceneName>_AccountLinking
.
Personaliza la escena de vinculación de cuentas
- En Scenes, selecciona la escena del sistema de vinculación de cuentas.
- Haz clic en Send prompt y agrega una oración breve para describirle al usuario por qué la acción necesita acceder a su identidad (por ejemplo, "Para guardar tus preferencias").
- Haz clic en Guardar.
- En Condiciones, haz clic en Si el usuario completa la vinculación de cuentas correctamente.
- Configura cómo debe proceder el flujo si el usuario acepta vincular su cuenta. Por ejemplo, llama al webhook para procesar cualquier lógica empresarial personalizada que se requiera y realizar la transición a la escena de origen.
- Haz clic en Guardar.
- En Condiciones, haz clic en Si el usuario cancela o descarta la vinculación de cuentas.
- Configura cómo debe proceder el flujo si el usuario no acepta vincular su cuenta. Por ejemplo, envía un mensaje de confirmación y redirecciona a escenas que proporcionen funcionalidades que no requieren la vinculación de cuentas.
- Haz clic en Guardar.
- En Condiciones, haz clic en Si se produce un error de sistema o red.
- Configura cómo debe proceder el flujo si el flujo de vinculación de cuentas no se puede completar debido a errores del sistema o de la red. Por ejemplo, envía un mensaje de confirmación y redirecciona a escenas que proporcionen funcionalidades que no requieren la vinculación de cuentas.
- Haz clic en Guardar.
Controla las solicitudes de acceso a los datos
Si la solicitud de Asistente contiene un token de acceso, primero verifica que el token de acceso sea válido y no haya vencido. Luego, recupera la cuenta de usuario asociada con el token en tu base de datos de la cuenta de usuario.