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 para Google Chat:
Configura un proyecto de Google Cloud, habilita la API de Chat y configura la app de Chat: Durante el desarrollo, creas un proyecto de Google Cloud. En el proyecto de Google Cloud, debes habilitar la API de Chat, configurar la app de Chat y configurar la autenticación. Para obtener más información, consulta Desarrolla en Google Workspace y Compila una app de Chat.
Llamar a la API de Chat: Cuando tu app llama a la API de Chat, le envía credenciales de autenticación. Si tu app se autentica con una cuenta de servicio, las credenciales se envían como parte del código de la 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 permisos otorgados. Si la lista de permisos que se muestra es más restrictiva que los permisos solicitados, tu app desactivará cualquier función limitada 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 la app debe acceder a la API de Google Chat más allá de la vida útil de un solo token de acceso, puede obtener un token de actualización. Si quieres 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 solicita 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 las 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 RESTful 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 usuario o 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 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 una 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 con 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 los 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íncrona entre una app de Chat y un espacio de Chat:
- Para crear un mensaje, una app de Chat llama a la API de Chat con el método
spaces.messages.create
y, además, incluye las credenciales del usuario en la solicitud HTTP. - Google Chat autentica la app de Chat con la cuenta de servicio o las 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 los permisos para definir la información que se mostrará a los usuarios y revisores de apps, y registra la app a fin de que puedas publicarla más tarde.
Para definir el nivel de acceso otorgado a tu app, debes identificar y declarar los permisos 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 del permiso | Descripción |
---|---|
https://www.googleapis.com/auth/chat.bot
|
El permiso Permite que las apps de Chat vean los chats y envíen mensajes. Otorga acceso a todas las funciones disponibles para las apps de Chat. |
Permisos sensibles
Código del permiso | Descripción |
---|---|
https://www.googleapis.com/auth/chat.spaces
|
Crea conversaciones y espacios, y consulta o edita los metadatos (incluida la configuración del historial y la configuración de acceso) en Chat. |
https://www.googleapis.com/auth/chat.spaces.create
|
Crea 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
|
Ve, agrega, actualiza y quita 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 de 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
|
Consulta y modifica la hora de la última lectura en las conversaciones de Chat. |
https://www.googleapis.com/auth/chat.users.readstate.readonly
|
Consulta 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.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 |
Permisos restringidos
Código del permiso | 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 Si quieres obtener más información, consulta Autoriza apps de Chat a importar datos. |
https://www.googleapis.com/auth/chat.messages
|
Puedes 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 |
Los alcances 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 la verificación básica de la app. Si deseas obtener información sobre este requisito, consulta Pasos de preparación 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. Se requiere que realices una verificación adicional de la app. Si deseas obtener información sobre este requisito, consulta Pasos para las apps que solicitan alcances sensibles.
Restringido: Estos permisos proporcionan un acceso amplio a los datos del usuario de Google y requieren que realices el proceso de verificación de permiso restringido. Para obtener información sobre este requisito, consulta Servicios de las APIs de Google: Política de datos del usuario y 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 alcances de la API de Google, consulta Cómo usar 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 Configura la pantalla de consentimiento de OAuth y elige los alcances.
Tipos de autenticación requerida
Existen dos formas en que las apps de Chat pueden autenticarse y autorizar con la API de Chat: credenciales de usuario o cuentas de servicio.
Con la autorización de credenciales de usuario, una app de Chat puede acceder a los datos del usuario y completar acciones en su nombre. Los permisos de OAuth especifican los datos y las acciones autorizados.
Con la autorización de apps, una app de Chat accede
a la API como una app con credenciales de cuenta de servicio. La autorización de apps siempre usa el alcance de autorización chat.bot
.
Cuando decidas qué tipo de credencial usar para una solicitud a la API en particular, ten en cuenta que algunos métodos de la API solo admiten un tipo particular de credencial. Si un método de API admite ambas credenciales, el tipo de credencial usado en la llamada afecta el resultado que se muestra:
- Con la autorización de la app, los métodos solo muestran recursos a los que puede acceder la app.
- Con la autorización del usuario, los métodos solo muestran recursos a los que el usuario puede acceder en la IU de Chat.
Por ejemplo, si llamas al método ListSpaces
con la autorización de la app, se muestra la lista de espacios a los que pertenece la app. Si llamas a ListSpaces
con la autorización del usuario, se muestra la lista de espacios a los que pertenece el usuario. En la práctica, tu app podría usar ambos tipos de autorización cuando llame a la API de Chat, según la funcionalidad que desees.
Para las 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 admitidos:
Método | Compatible con la autenticación de usuarios | Compatible con la autenticación de apps | Se admiten los permisos de autorización | |
---|---|---|---|---|
Espacios | ||||
Crea un espacio | — |
Con la autenticación de usuarios:
|
||
Configura un espacio | — |
Con la autenticación de usuarios:
|
||
Obtén un espacio |
Con la autenticación de usuarios:
|
|||
Crea listas de espacios |
Con la autenticación de usuarios:
|
|||
Buscar espacios |
Si usas la autenticación de usuarios con privilegios de administrador, ocurre lo siguiente:
|
|||
Actualiza un espacio | — |
Con la autenticación de usuarios:
|
||
Cómo borrar un espacio | — |
Con la autenticación de usuarios:
|
||
Cómo completar el proceso de importación de un espacio | — |
Con la autenticación de usuarios:
|
||
Cómo encontrar un mensaje directo |
Con la autenticación de usuarios:
|
|||
Miembros | ||||
Crea un miembro | — |
Con la autenticación de usuarios:
|
||
Obtén un miembro |
Con la autenticación de usuarios:
|
|||
Miembros de la lista |
Con la autenticación de usuarios:
|
|||
Cómo borrar un miembro | — |
Con la autenticación de usuarios:
|
||
Mensajes | ||||
Crea un mensaje |
Con la autenticación de usuarios:
|
|||
Recibir un mensaje |
Con la autenticación de usuarios:
|
|||
Cómo enumerar mensajes | — |
Con la autenticación de usuarios:
|
||
Actualiza un mensaje |
Con la autenticación de usuarios:
|
|||
Cómo borrar un mensaje |
Con la autenticación de usuarios:
|
|||
Reacciones | ||||
Cómo crear una reacción | — |
Con la autenticación de usuarios:
|
||
Cómo enumerar reacciones | — |
Con la autenticación de usuarios:
|
||
Cómo borrar una reacción | — |
Con la autenticación de usuarios:
|
||
Contenido multimedia y archivos adjuntos | ||||
Cómo subir contenido multimedia como archivo adjunto | — |
Con la autenticación de usuarios:
|
||
Descarga contenido multimedia |
Con la autenticación de usuarios:
|
|||
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 de usuarios:
|
||
Obtén el estado de lectura de subprocesos de un usuario | — |
Con la autenticación de usuarios:
|
||
Eventos espaciales | ||||
Obtener eventos espaciales | — |
Con la autenticación de usuarios:
|
||
Genera una lista de los eventos del espacio | — |
Con la autenticación de usuarios:
|
Eventos de interacción con 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 se requiere o admite autenticación:
Situación | No se requiere autenticación | Compatible con la autenticación de usuarios | Compatible con la autenticación de apps | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Recibir mensajes de: |
|
|||||||||||||||
Responder mensajes: |
|
|||||||||||||||
Envía 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 la 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.
- Para obtener más información sobre cómo las APIs de Google aprovechan OAuth 2.0, consulta Usar OAuth 2.0 para acceder a las APIs de Google.
- Configura la autenticación y autorización con credenciales de usuario o una cuenta de servicio.