La autenticación y la autorización son mecanismos que se usan para verificar la identidad y el acceso a los recursos, respectivamente. En este documento, se describe cómo funcionan la autenticación y la autorización para las apps de Chat y las solicitudes a la API de Chat.
Descripción general del proceso
En el siguiente diagrama, se muestran los pasos de alto nivel de autenticación y autorización de Google Chat:
Configura un proyecto de Google Cloud, habilita la API de Chat y configura tu app de Chat: Durante el desarrollo, creas un proyecto de Google Cloud. En el proyecto de Google Cloud, habilitas la API de Chat, configuras tu app de Chat y configuras la autenticación. Para obtener más información, consulta Desarrollo en Google Workspace y Cómo compilar una app de Chat.
Llama a la API de Chat: Cuando tu app llama a la API de Chat, envía credenciales de autenticación a la API de Chat. Si tu app se autentica con una cuenta de servicio, las credenciales se envían como parte del código de tu app. Si tu app requiere llamar a la API de Chat con la autenticación de un usuario que aún no se otorgó, se le pedirá al usuario que acceda.
Solicita recursos: Tu app solicita acceso con los alcances que especificas cuando configuras la autenticación.
Solicita el consentimiento: Si tu app se autentica como usuario, Google muestra una pantalla de consentimiento de OAuth para que el usuario pueda decidir si le otorga a tu app acceso a los datos solicitados. La autenticación con una cuenta de servicio no requiere el consentimiento del usuario.
Envía una solicitud aprobada de recursos: Si el usuario da su consentimiento para los permisos de autorización, tu app agrupa las credenciales y los permisos aprobados por el usuario en una solicitud. La solicitud se envía al servidor de autorización de Google para obtener un token de acceso.
Google muestra un token de acceso: El token de acceso contiene una lista de los permisos otorgados. Si la lista de alcances que se muestra es más restrictiva que los alcances solicitados, tu app desactivará las funciones limitadas por el token.
Acceso a recursos solicitados: La app usa el token de acceso de Google para invocar a la API de Chat y acceder a los recursos de esta última.
Obtén un token de actualización (opcional): Si tu app debe acceder a la API de Google Chat más allá del ciclo de vida de un solo token de acceso, puede obtener un token de actualización. Si deseas obtener más información, consulta Usa OAuth 2.0 para acceder a las APIs de Google.
Solicita más recursos: Si tu app necesita más acceso, le pide al usuario que otorgue permisos nuevos, lo que genera una solicitud nueva para obtener un token de acceso (pasos 3-6).
Cuándo las apps de chat requieren autenticación
Las apps de chat pueden enviar mensajes en respuesta a una interacción del usuario o de forma asíncrona. También pueden completar tareas en nombre de un usuario, como crear un espacio de Chat o obtener una lista de personas en un espacio de Chat.
Las apps de Chat no requieren autenticación para responder a una interacción del usuario, a menos que la app de Chat llame a la API de Chat o a otra API de Google mientras procesa una respuesta.
Para enviar mensajes asíncronos o realizar tareas en nombre de un usuario, las apps de Chat realizan solicitudes REST a la API de Chat, que requieren autenticación y autorización.
Las respuestas a las interacciones del usuario no requieren autenticación
Las apps de Google Chat no necesitan autenticarse como un usuario ni una app de Chat para recibir y responder de forma síncrona a los eventos de interacción.
Las apps de Google Chat reciben eventos de interacción cada vez que un usuario interactúa o invoca una app de Chat, lo que incluye lo siguiente:
- Un usuario envía un mensaje a una app de Chat.
- Un usuario menciona con @ una app de Chat.
- Un usuario invoca uno de los comandos de barra de la app de Chat.
En el siguiente diagrama, se muestra una secuencia de solicitud-respuesta entre un usuario de Chat y la app de Chat:
- El usuario envía un mensaje a la app de Chat en Google Chat.
- Google Chat reenvía el mensaje a la app.
- La app recibe el mensaje, lo procesa y muestra una respuesta a Google Chat.
- Google Chat renderiza la respuesta para el usuario o en un espacio.
Esta secuencia se repite para cada evento de interacción de la app de Chat.
Los mensajes asíncronos requieren autenticación
Los mensajes asíncronos se producen cuando una app de Chat realiza una solicitud a la API de Chat, que requiere autenticación y autorización.
Cuando se llama a la API de Chat, las apps de Chat pueden publicar mensajes en Google Chat o completar tareas y acceder a datos en nombre de un usuario. Por ejemplo, después de detectar una interrupción del servidor, una app de Chat puede llamar a la API de Chat para hacer lo siguiente:
- Crea un espacio de Chat dedicado a investigar y solucionar la interrupción.
- Agregar personas al espacio de Chat
- Publica un mensaje en el espacio de Chat para proporcionar detalles sobre la interrupción.
En el siguiente diagrama, se muestra una secuencia de mensajes asíncronos entre una app de Chat y un espacio de Chat:
- Una app de Chat crea un mensaje llamando a la API de Chat con el método
spaces.messages.createy, luego, incluye las credenciales del usuario en la solicitud HTTP. - Google Chat autentica la app de Chat con una cuenta de servicio o credenciales de usuario.
- Google Chat renderiza el mensaje de la app en un espacio de Chat especificado.
Permisos de la API de Chat
Configura la pantalla de consentimiento de OAuth y elige permisos para definir qué información se muestra a los usuarios y revisores de apps, y registra tu app para que puedas publicarla más adelante.
Para definir el nivel de acceso otorgado a tu app, debes identificar y declarar los alcances de autorización. Un alcance de autorización es una cadena de URI de OAuth 2.0 que contiene el nombre de la app de Google Workspace, el tipo de datos a los que accede y el nivel de acceso.
Alcances no sensibles
| Código de alcance | Descripción |
|---|---|
https://www.googleapis.com/auth/chat.bot
|
Permite que las apps de Chat vean chats y envíen mensajes. Este alcance solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación de todo el dominio con este permiso. |
Permisos sensibles
| Código de alcance | Descripción |
|---|---|
https://www.googleapis.com/auth/chat.spaces
|
Crear conversaciones y espacios, y ver o editar metadatos (incluida la configuración del historial y la configuración de acceso) en Chat |
https://www.googleapis.com/auth/chat.spaces.create
|
Crear conversaciones nuevas en Chat |
https://www.googleapis.com/auth/chat.spaces.readonly
|
Ver el chat y los espacios en Chat |
https://www.googleapis.com/auth/chat.memberships
|
Ver, agregar, actualizar y quitar miembros de las conversaciones en Chat |
https://www.googleapis.com/auth/chat.memberships.app
|
Unirse a las conversaciones de Google Chat y salir de ellas |
https://www.googleapis.com/auth/chat.memberships.readonly
|
Ver a los miembros de las conversaciones de Chat |
https://www.googleapis.com/auth/chat.messages.create
|
Redactar y enviar mensajes en Chat |
https://www.googleapis.com/auth/chat.messages.reactions
|
Ver, agregar y borrar reacciones a los mensajes en Chat |
https://www.googleapis.com/auth/chat.messages.reactions.create
|
Agregar reacciones a un mensaje en Chat |
https://www.googleapis.com/auth/chat.messages.reactions.readonly
|
Ver las reacciones a un mensaje en Chat |
https://www.googleapis.com/auth/chat.users.readstate
|
Ver y modificar la hora de la última lectura en las conversaciones de Chat |
https://www.googleapis.com/auth/chat.users.readstate.readonly
|
Ver la hora de la última lectura en las conversaciones de Chat |
https://www.googleapis.com/auth/chat.admin.spaces.readonly
|
Ver el chat y los espacios que pertenecen al dominio del administrador en Chat |
https://www.googleapis.com/auth/chat.admin.spaces
|
Ver o editar el chat y los espacios que pertenecen al dominio del administrador en Chat |
https://www.googleapis.com/auth/chat.admin.memberships.readonly
|
Ver miembros y administradores en conversaciones que pertenecen al dominio del administrador en Chat |
https://www.googleapis.com/auth/chat.admin.memberships
|
Ver, agregar, actualizar y quitar miembros y administradores en las conversaciones que pertenecen al dominio del administrador en Chat |
https://www.googleapis.com/auth/chat.app.spaces
|
Crear conversaciones y espacios, y ver o actualizar metadatos (incluida la configuración del historial y la configuración de acceso) en Chat Requiere aprobación del administrador. Este alcance solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con delegación de todo el dominio mediante este alcance. |
https://www.googleapis.com/auth/chat.app.spaces.create
|
Crear conversaciones y espacios nuevos en Chat Requiere aprobación del administrador. Este alcance solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación de todo el dominio con este permiso. |
https://www.googleapis.com/auth/chat.app.memberships
|
Ver, agregar, actualizar y quitar miembros de las conversaciones y los espacios de Chat Requiere la aprobación del administrador. Este alcance solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación de todo el dominio con este permiso. |
https://www.googleapis.com/auth/chat.customemojis
|
Ver, crear y borrar emojis personalizados en Chat |
https://www.googleapis.com/auth/chat.customemojis.readonly
|
Ver emojis personalizados en Chat |
https://www.googleapis.com/auth/chat.users.spacesettings
|
Consulta y actualiza la configuración del espacio de usuario de Chat.
Consulta las APIs de configuración del usuario del espacio: getSpaceNotificationSetting y updateSpaceNotificationSetting. |
Permisos restringidos
| Código de alcance | Descripción |
|---|---|
https://www.googleapis.com/auth/chat.delete
|
Borrar conversaciones y espacios, y quitar el acceso a los archivos asociados en Chat |
https://www.googleapis.com/auth/chat.import
|
Importar espacios, mensajes y membresías a Chat Para obtener más información, consulta Cómo autorizar apps de Chat para importar datos. |
https://www.googleapis.com/auth/chat.messages
|
Ver, redactar, enviar, actualizar y borrar mensajes, así como agregar, ver y borrar reacciones a los mensajes. |
https://www.googleapis.com/auth/chat.messages.readonly
|
Ver mensajes y reacciones en Chat |
https://www.googleapis.com/auth/chat.admin.delete
|
Borrar conversaciones y espacios que pertenecen al dominio del administrador, y quitar el acceso a los archivos asociados en Chat |
https://www.googleapis.com/auth/chat.app.delete
|
Borrar conversaciones y espacios, y quitar el acceso a los archivos asociados en Chat Requiere la aprobación del administrador. Este alcance solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación de todo el dominio con este permiso. |
Los permisos de las tablas anteriores indican su sensibilidad, según las siguientes definiciones:
No sensibles: Estos permisos proporcionan la esfera más pequeña de acceso de autorización y solo requieren una verificación básica de la app. Para obtener información sobre este requisito, consulta Pasos para prepararte para la verificación.
Sensibles: Estos permisos le proporcionan a tu app acceso a los datos de Google de un usuario específico después de recibir la autorización del usuario. Para acceder a las funciones, debes realizar una verificación adicional de la app. Si deseas obtener información sobre este requisito, consulta Pasos para las apps que solicitan alcances sensibles.
Restringidos: Estos permisos proporcionan un acceso amplio a los datos del usuario de Google y requieren que realices el proceso de verificación de permisos restringidos. Para obtener información sobre este requisito, consulta la Política de Datos del Usuario de los Servicios de la API de Google y los Requisitos Adicionales para Permisos Específicos de la API. Consulta también Pasos para apps que solicitan permisos restringidos.
Si tu app requiere acceso a cualquier otra API de Google, también puedes agregar esos alcances. Para obtener más información sobre los permisos de las APIs de Google, consulta Usa OAuth 2.0 para acceder a las APIs de Google.
Para obtener más información sobre los permisos de las APIs de Google Workspace, consulta Cómo configurar la pantalla de consentimiento de OAuth y elegir permisos.
Tipos de autenticación requerida
Existen dos formas en que las apps de Chat pueden autenticarse y autorizar con la API de Chat:
- Autenticación de usuarios
- La autenticación del usuario permite que una app de Chat acceda a los datos del usuario y complete acciones en su nombre. Los permisos de OAuth especifican los datos y las acciones autorizados. A menos que la app de Chat se haya instalado como administrador o se le haya otorgado la delegación de todo el dominio, la primera vez que la app de Chat realice una acción en nombre de un usuario, este deberá autorizarla con la pantalla de consentimiento de OAuth.
- Autenticación de apps
La autenticación de apps permite que una app de Chat use credenciales de cuenta de servicio, acceda a los datos y complete acciones en sí misma. Debido a que la app de Chat usa sus propias credenciales para acceder a los recursos y trabajar con ellos, los usuarios finales no necesitan aprobar las llamadas a la API de la app de Chat, y no puedes agregar permisos de autorización de OAuth que admitan la autorización de apps a la pantalla de consentimiento de OAuth.
Hay dos tipos de permisos de autorización de OAuth que admiten la autenticación de apps:
https://www.googleapis.com/auth/chat.bot: Tu app de Chat puede llamar a los métodos de la API de Google Chat que admiten este permiso de autorización para crear, actualizar, obtener, enumerar o borrar recursos a los que tiene acceso, como los mensajes en los espacios a los que los usuarios finales agregan tu app de Chat. Tu app de chat puede otorgarse este permiso de forma automática, sin necesidad de autorización del administrador ni del usuario final.https://www.googleapis.com/auth/chat.app.*(Versión preliminar para desarrolladores): El uso de estos permisos requiere la aprobación del administrador por única vez. Para obtener la aprobación del administrador, prepara la cuenta de servicio de la app de Chat para recibir la aprobación del administrador. Para ello, crea un cliente de OAuth compatible con Google Workspace Marketplace y configura la app en el SDK de Google Workspace Marketplace. Estos permisos permiten que tu app de Chat llame a métodos específicos de la API de Google Chat. Por ejemplo,chat.app.spaces.createpermite que las apps creen espacios de Chat.
Si un método admite la autenticación de usuarios o apps, la API de Chat muestra resultados diferentes según el tipo de autenticación que uses:
- Con la autenticación de apps, los métodos solo muestran recursos a los que puede acceder la app de Chat.
- Con la autenticación del usuario, los métodos solo muestran los recursos a los que puede acceder el usuario.
Por ejemplo, llamar al método spaces.list() con la autorización de la app muestra la lista de espacios de los que es miembro la app de Chat.
Si llamas a spaces.list() con la autorización del usuario, se muestra la lista de espacios de los que es miembro. En la práctica, puedes usar ambos tipos de autenticación cuando llames a la API de Chat, según el diseño y las funciones de tu app de Chat.
Para llamadas asíncronas a la API de Chat
En la siguiente tabla, se enumeran los métodos de la API de Chat y sus permisos de autorización compatibles:
| Método | Compatible con la autenticación de usuarios | Autenticación de la app compatible | Permisos de autorización admitidos | |
|---|---|---|---|---|
| Espacios | ||||
| Crea un espacio |
Con la autenticación del usuario:
|
|||
| Configura un espacio | — |
Con la autenticación del usuario:
|
||
| Obtén un espacio |
Con la autenticación del usuario:
|
|||
| Crea listas de espacios |
Con la autenticación del usuario:
|
|||
| Buscar espacios | — |
Con la autenticación de usuarios con privilegios de administrador:
|
||
| Actualiza un espacio |
Con la autenticación del usuario:
|
|||
| Cómo borrar un espacio |
Con la autenticación del usuario:
|
|||
| Completa el proceso de importación de un espacio | — |
Con la autenticación del usuario:
|
||
| Cómo encontrar un mensaje directo |
Con la autenticación del usuario:
|
|||
| Miembros | ||||
| Crea un miembro |
Con la autenticación del usuario:
|
|||
| Obtén un miembro |
Con la autenticación del usuario:
|
|||
| Miembros de la lista |
Con la autenticación del usuario:
|
|||
| Cómo borrar un miembro |
Con la autenticación del usuario:
|
|||
| Actualiza un miembro |
Con la autenticación de usuarios:
|
|||
| Mensajes | ||||
| Cómo crear un mensaje |
Con la autenticación del usuario:
|
|||
| Cómo recibir un mensaje |
Con la autenticación del usuario:
|
|||
| Crea una lista de mensajes | — |
Con la autenticación del usuario:
|
||
| Cómo actualizar un mensaje |
Con la autenticación de usuarios:
|
|||
| Cómo borrar un mensaje |
Con la autenticación del usuario:
|
|||
| Reacciones | ||||
| Cómo crear una reacción | — |
Con la autenticación del usuario:
|
||
| Crea una lista con las reacciones | — |
Con la autenticación del usuario:
|
||
| Cómo borrar una reacción | — |
Con la autenticación del usuario:
|
||
| Emojis personalizados | ||||
| Cómo crear un emoji personalizado | — |
Con la autenticación del usuario:
|
||
| Cómo borrar un emoji personalizado | — |
Con la autenticación del usuario:
|
||
| Obtén un emoji personalizado | — |
Con la autenticación de usuarios:
|
||
| Lista de emojis personalizados | — |
Con la autenticación del usuario:
|
||
| Medios y archivos adjuntos | ||||
| Cómo subir contenido multimedia como archivo adjunto | — |
Con la autenticación del usuario:
|
||
| Descarga contenido multimedia |
Con la autenticación del usuario:
|
|||
| Cómo recibir un archivo adjunto de un mensaje | — |
Con la autenticación de apps:
|
||
| Estados de lectura de los usuarios | ||||
| Obtén el estado de lectura del espacio de un usuario | — |
Con la autenticación de usuarios:
|
||
| Actualiza el estado de lectura del espacio de un usuario | — |
Con la autenticación del usuario:
|
||
| Obtén el estado de lectura de un usuario en un subproceso | — |
Con la autenticación del usuario:
|
||
| Configuración del espacio de usuario | ||||
| Obtén la configuración de notificaciones de un espacio de un usuario | — |
Con la autenticación de usuarios:
|
||
| Actualiza la configuración de notificaciones de un espacio de un usuario | — |
Con la autenticación del usuario:
|
||
| Eventos de Spaces | ||||
| Obtener eventos espaciales | — |
Con la autenticación del usuario, debes usar un permiso basado en el tipo de evento:
|
||
| Lista de eventos del espacio | — |
Con la autenticación del usuario, debes usar un permiso para cada
tipo de evento incluido en la solicitud:
|
||
Para eventos de interacción de la app de Chat
En la siguiente tabla, se enumeran las formas comunes en que los usuarios interactúan con las apps de Chat y si la autenticación es obligatoria o compatible:
| Situación | No se requiere autenticación | Autenticación de usuarios compatible | Autenticación de la app compatible | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Recibir mensajes de: |
|
|||||||||||||||
| Responder mensajes: |
|
|||||||||||||||
| Enviar mensajes nuevos: |
|
|||||||||||||||
Temas relacionados
- Para obtener una descripción general de la autenticación y autorización en Google Workspace, consulta Más información sobre la autenticación y la autorización.
- Para obtener una descripción general de la autenticación y autorización en Google Cloud, consulta Descripción general de la autenticación.
- Para obtener más información sobre las cuentas de servicio, consulta Cuentas de servicio.
- Si deseas obtener más información sobre cómo las APIs de Google usan OAuth 2.0, consulta Usa OAuth 2.0 para acceder a las APIs de Google.
- Configura la autenticación y la autorización con credenciales de usuario o una cuenta de servicio.