Authentifier et autoriser les applications Chat et les requêtes API Google Chat

L'authentification et l'autorisation sont des mécanismes utilisés pour vérifier l'identité et l'accès aux ressources, respectivement. Ce document décrit comment l'authentification et pour les applications Chat et les requêtes API Chat.

Présentation du processus

Le schéma suivant illustre les principales étapes d'authentification pour Google Chat:

Principales étapes d'authentification et d'autorisation pour Google Chat
Figure 1. Étapes générales pour l'authentification et l'autorisation dans Google Chat

  1. Configurez un projet Google Cloud, activez l'API Chat et configurez votre Application Chat:pendant le développement, vous créez projet Google Cloud. Dans le projet Google Cloud, vous activez l'API Chat, configurer votre application Chat et configurer l'authentification. Pour en savoir plus, consultez Développer sur Google Workspace et Créer une application Chat.

  2. API Call Chat:lorsque votre application appelle l'API l'API Chat, elle envoie des identifiants d'authentification au API Chat. Si votre application s'authentifie avec un compte de service, les identifiants sont envoyés du code de votre application. Si votre application nécessite d'appeler l'API Chat en utilisant l'authentification d'un utilisateur qui n'a pas encore été accordée, l'invite de commande à se connecter.

  3. Demander des ressources: votre application demande l'accès avec habilitations que vous spécifiez lors de la configuration de l'authentification.

  4. Demander l'autorisation:si votre application s'authentifie en tant qu'utilisateur, Google affiche un écran de consentement OAuth afin que l'utilisateur puisse décider d'accorder ou non votre application l'accès aux données demandées. L'authentification avec un compte de service sans le consentement de l'utilisateur.

  5. Envoyez une demande de ressources approuvée:si l'utilisateur accepte les d'autorisation, votre app bundles les identifiants et le certificat des champs d'application dans une requête. La requête est envoyée au serveur d'autorisation Google pour obtenir un jeton d'accès.

  6. Google renvoie un jeton d'accès:ce jeton contient une liste de les niveaux d'accès accordés. Si la liste de champs d'application renvoyée est plus restrictive que les champs d'application demandés, votre application désactive toutes les fonctionnalités limitées par le jeton.

  7. Accès aux ressources demandées:votre application utilise le jeton d'accès de Google pour appeler l'API Chat et accéder à ses ressources.

  8. Obtenir un jeton d'actualisation (facultatif) : si votre application doit accéder à la l'API Google Chat au-delà de la durée de vie d'un jeton d'accès unique, elle peut obtenir d'actualisation. Pour en savoir plus, consultez Utiliser OAuth 2.0 pour accéder aux API Google

  9. Demander plus de ressources:si votre application a besoin d'un accès plus étendu, elle demande à l'utilisateur pour accorder de nouveaux champs d'application, ce qui entraîne une nouvelle demande d'obtention d'un jeton d'accès (étapes 3 à 6).

Lorsque les applications Chat nécessitent une authentification

Les applications de chat peuvent envoyer des messages en réponse à une interaction de l'utilisateur. de manière asynchrone. Ils peuvent également effectuer des tâches pour le compte d'un utilisateur, par exemple créer un espace Chat ou obtenir la liste des membres d'une Espace Chat.

Les applications de chat ne requièrent pas d'authentification pour répondre à une interaction avec l'utilisateur, sauf si l'application Chat appelle API Chat ou une autre API Google, tout en le traitement d'une réponse.

Pour envoyer des messages asynchrones ou effectuer des tâches au nom d'un utilisateur, Les applications de chat envoient des requêtes RESTful au API Chat qui requièrent une authentification et une autorisation.

Les réponses aux interactions des utilisateurs ne nécessitent pas d'authentification

Les applications Google Chat n'ont pas besoin de s'authentifier Application Chat permettant de recevoir des messages et d'y répondre de manière synchrone événements d'interaction.

Les applications Google Chat reçoivent des événements d'interaction chaque fois qu'un utilisateur interagit ou appelle une application Chat, y compris ce qui suit:

  • Un utilisateur envoie un message à une application Chat.
  • Un utilisateur mentionne @une application Chat.
  • Un utilisateur appelle l'une des commandes à barre oblique.

Le schéma suivant illustre une séquence requête-réponse entre une Utilisateur Chat et application Chat:

Aucune autorisation requise pour les événements d'interaction avec l'application Chat
Figure 2 : Les événements d'interaction avec l'application Chat ne nécessitent pas d'authentification.

  1. L'utilisateur envoie un message à l'application Chat dans Google Chat.
  2. Google Chat transfère le message vers l'application.
  3. L'application reçoit le message, le traite et renvoie une réponse à Google Chat.
  4. Google Chat affiche la réponse pour l'utilisateur ou dans un espace.

Cette séquence se répète pour chaque interaction avec l'application Chat .

Les messages asynchrones nécessitent une authentification

Les messages asynchrones se produisent lorsqu'une application Chat effectue à API Chat qui nécessite une authentification et une autorisation.

En appelant l'API Chat, les applications Chat peuvent publier des messages à Google Chat, ou d'effectuer des tâches et d'accéder à des données pour le compte d'un utilisateur. Pour Par exemple, après avoir détecté une panne de serveur, une application de chat peut appeler API Chat pour:

  • Créez un espace Chat dédié à l'examen et à la résolution du problème. en cas d'interruption de service.
  • Ajoutez des personnes à l'espace Chat.
  • Publiez un message dans l'espace Chat pour fournir des détails sur le en cas d'interruption de service.

Le schéma suivant illustre une séquence de messages asynchrone entre un Application Chat et espace Chat:

Authentification requise pour les messages asynchrones
Figure 3. Les messages asynchrones nécessitent une authentification.

  1. Une application Chat crée un message en appelant la méthode API Chat à l'aide du spaces.messages.create de commande, et inclut les identifiants de l'utilisateur dans la requête HTTP.
  2. Google Chat authentifie l'application Chat avec compte de service ou identifiants utilisateur.
  3. Google Chat affiche le message de l'application dans une application Chat spécifiée l'espace de stockage.

Champs d'application des API Chat

Configurer l'écran de consentement OAuth et choisir les niveaux d'accès de définir les informations présentées aux utilisateurs et aux examinateurs de l'application, votre application pour pouvoir la publier ultérieurement.

Pour définir le niveau d'accès accordé à votre application, vous devez identifier et déclarer des niveaux d'autorisation ; Un champ d'application d'autorisation est un URI OAuth 2.0 qui contient le nom de l'application Google Workspace, le type de données les accès et le niveau d'accès.

Champs d'application non sensibles

Code du champ d'application Description
https://www.googleapis.com/auth/chat.bot

Le champ d'application chat.bot n'accepte que les comptes de service. Toi ne peut pas s'authentifier avec les identifiants de l'utilisateur délégation au niveau du domaine à l'aide de ce champ d'application.

Permet aux applications Chat d'afficher les discussions et d'envoyer des messages. Dons l'accès à toutes les fonctionnalités disponibles pour les applications Chat.

Champs d'application sensibles

Code du champ d'application Description
https://www.googleapis.com/auth/chat.spaces créer des conversations et des espaces, et afficher ou modifier les métadonnées (y compris paramètres d'historique et d'accès) dans Chat.
https://www.googleapis.com/auth/chat.spaces.create créer des conversations dans Chat ;
https://www.googleapis.com/auth/chat.spaces.readonly Affichez le chat et les espaces dans Chat.
https://www.googleapis.com/auth/chat.memberships Affichez les participants aux conversations dans Chat, ajoutez-en, modifiez-les et supprimez-en.
https://www.googleapis.com/auth/chat.memberships.app S'ajouter aux conversations dans Google Chat et s'en supprimer.
https://www.googleapis.com/auth/chat.memberships.readonly Affichez les participants dans les conversations Chat.
https://www.googleapis.com/auth/chat.messages.create Rédigez et envoyez des messages dans Chat.
https://www.googleapis.com/auth/chat.messages.reactions Affichez, ajoutez et supprimez des réactions aux messages dans Chat.
https://www.googleapis.com/auth/chat.messages.reactions.create Ajoutez des réactions à un message dans Chat.
https://www.googleapis.com/auth/chat.messages.reactions.readonly Affichez les réactions à un message dans Chat.
https://www.googleapis.com/auth/chat.users.readstate Affichez et modifiez l'heure de dernière lecture des conversations Chat.
https://www.googleapis.com/auth/chat.users.readstate.readonly Afficher l'heure de dernière lecture des conversations Chat.
https://www.googleapis.com/auth/chat.admin.spaces.readonly afficher les discussions et les espaces appartenant au domaine de l'administrateur dans Chat.
https://www.googleapis.com/auth/chat.admin.spaces Afficher ou modifier les discussions et les espaces appartenant au domaine de l'administrateur dans Chat.
https://www.googleapis.com/auth/chat.admin.memberships.readonly Affichez les participants et les gestionnaires dans les conversations appartenant au domaine de l'administrateur dans Chat.
https://www.googleapis.com/auth/chat.admin.memberships Affichez, ajoutez, modifiez et supprimez des participants et des gestionnaires dans les conversations appartenant au domaine de l'administrateur dans Chat.

Champs d'application restreints

Code du champ d'application Description
https://www.googleapis.com/auth/chat.delete Supprimer des conversations et des espaces, et supprimer l'accès aux fichiers associés dans Chat.
https://www.googleapis.com/auth/chat.import Importer des espaces, des messages et des membres dans Chat Pour Pour en savoir plus, consultez Autoriser les applications Chat à importer des données
https://www.googleapis.com/auth/chat.messages Afficher, rédiger, envoyer, mettre à jour et supprimer des messages, et ajouter, afficher et supprimer des réactions aux messages.
https://www.googleapis.com/auth/chat.messages.readonly Consultez les messages et les réactions dans Chat.
https://www.googleapis.com/auth/chat.admin.delete Supprimer des conversations et des espaces appartenant au domaine de l'administrateur, et supprimer l'accès aux fichiers associés dans Chat.

Les champs d'application des tableaux précédents indiquent leur sensibilité, en fonction du définitions suivantes:

Si votre application a besoin d'accéder à d'autres API Google, vous pouvez ajouter ces niveaux d'accès . Pour plus d'informations sur les champs d'application des API Google, consultez la page Utilisation d'OAuth 2.0 pour Accédez aux API Google.

Pour en savoir plus sur les champs d'application des API Google Workspace, consultez Configurez l'écran de consentement OAuth et choisissez des niveaux d'accès.

Types d'authentification requises

Les applications Chat peuvent s'authentifier et autoriser API Chat: identifiants utilisateur ou comptes de service.

Avec l'autorisation des identifiants utilisateur, une application Chat peut accéder aux données des utilisateurs et effectuer des actions au nom d'un utilisateur. Les champs d'application OAuth spécifient les données et les actions autorisées.

Avec l'autorisation d'application, une application Chat accède l'API en tant qu'application à l'aide des identifiants du compte de service. Toujours autoriser les applications utilise le champ d'application d'autorisation chat.bot.

Pour décider quel type d'identifiant utiliser pour une requête API particulière, Gardez à l'esprit que certaines méthodes d'API n'acceptent qu'un type particulier identifiant. Si une méthode API accepte les deux identifiants, le type d'identifiant utilisé dans l'appel affecte le résultat renvoyé:

  • Avec l'autorisation de l'application, les méthodes ne renvoient que les ressources que l'application peut y accéder.
  • Avec l'autorisation de l'utilisateur, les méthodes ne renvoient que les ressources que l'utilisateur user auxquels vous pouvez accéder dans l'interface utilisateur de Chat.

Par exemple, appeler la méthode ListSpaces avec l'autorisation de l'application renvoie le liste des espaces dont l'application est membre. Appeler ListSpaces avec l'utilisateur L'autorisation affiche la liste des espaces dont l'utilisateur est membre. Dans il est possible que votre application utilise les deux types d'autorisation lors de l'appel API Chat, en fonction de la fonctionnalité souhaitée.

Pour les appels d'API Chat asynchrones

Le tableau suivant répertorie les méthodes de l'API Chat et les méthodes compatibles champs d'application des autorisations:

Méthode Compatible avec l'authentification des utilisateurs Compatibilité avec l'authentification des applications Champs d'application d'autorisation compatibles
Espaces  
Créer un espace Avec l'authentification des utilisateurs:
  • chat.spaces.create
  • chat.spaces
  • chat.import
Configurer un espace Avec l'authentification des utilisateurs:
  • chat.spaces.create
  • chat.spaces
Obtenir un espace Avec l'authentification des utilisateurs:
  • chat.spaces.readonly
  • chat.spaces
Avec l'authentification des applications:
  • chat.bot
Avec l'authentification des utilisateurs avec des droits d'administrateur:
  • chat.admin.spaces.readonly
Lister les espaces Avec l'authentification des utilisateurs:
  • chat.spaces.readonly
  • chat.spaces
Avec l'authentification des applications:
  • chat.bot
Rechercher dans les espaces Avec l'authentification des utilisateurs avec des droits d'administrateur:
  • chat.admin.spaces.readonly
Modifier un espace Avec l'authentification des utilisateurs:
  • chat.spaces
  • chat.import
Avec l'authentification des utilisateurs avec des droits d'administrateur:
  • chat.admin.spaces
Supprimer un espace Avec l'authentification des utilisateurs:
  • chat.delete
  • chat.import
Avec l'authentification des utilisateurs avec des droits d'administrateur:
  • chat.admin.delete
Terminer le processus d'importation d'un espace Avec l'authentification des utilisateurs:
  • chat.import
Rechercher un message privé Avec l'authentification des utilisateurs:
  • chat.spaces.readonly
  • chat.spaces
Avec l'authentification des applications:
  • chat.bot
Membres  
Créer un membre Avec l'authentification des utilisateurs:
  • chat.memberships
  • chat.memberships.app
  • chat.import
Avec l'authentification des utilisateurs avec des droits d'administrateur:
  • chat.admin.memberships
Récupérer un membre Avec l'authentification des utilisateurs:
  • chat.memberships.readonly
  • chat.memberships
Avec l'authentification des applications:
  • chat.bot
Avec l'authentification des utilisateurs avec des droits d'administrateur:
  • chat.admin.memberships.readonly
Membres de la liste Avec l'authentification des utilisateurs:
  • chat.memberships.readonly
  • chat.memberships
  • chat.import
Avec l'authentification des applications:
  • chat.bot
Avec l'authentification des utilisateurs avec des droits d'administrateur:
  • chat.admin.memberships.readonly
Supprimer un membre Avec l'authentification des utilisateurs:
  • chat.memberships
  • chat.memberships.app
  • chat.import
Avec l'authentification des utilisateurs avec des droits d'administrateur:
  • chat.admin.memberships
Mettre à jour un membre Avec l'authentification des utilisateurs:
  • chat.memberships
  • chat.import
Avec l'authentification des utilisateurs avec des droits d'administrateur:
  • chat.admin.memberships
Messages  
Créer un message Avec l'authentification des utilisateurs:
  • chat.messages.create
  • chat.messages
  • chat.import
Avec l'authentification des applications:
  • chat.bot
Recevoir un message Avec l'authentification des utilisateurs:
  • chat.messages.readonly
  • chat.messages
Avec l'authentification des applications:
  • chat.bot
Lister les messages Avec l'authentification des utilisateurs:
  • chat.messages.readonly
  • chat.messages
  • chat.import
Modifier un message Avec l'authentification des utilisateurs:
  • chat.messages
  • chat.import
Avec l'authentification des applications:
  • chat.bot
Supprimer un message Avec l'authentification des utilisateurs:
  • chat.messages
  • chat.import
Avec l'authentification des applications:
  • chat.bot
Réactions  
Créer une réaction Avec l'authentification des utilisateurs:
  • chat.messages.reactions.create
  • chat.messages.reactions
  • chat.messages
  • chat.import
Lister les réactions Avec l'authentification des utilisateurs:
  • chat.messages.reactions.readonly
  • chat.messages.reactions
  • chat.messages.readonly
  • chat.messages
Supprimer une réaction Avec l'authentification des utilisateurs:
  • chat.messages.reactions
  • chat.messages
  • chat.import
Médias et pièces jointes  
Importer un fichier multimédia en pièce jointe Avec l'authentification des utilisateurs:
  • chat.messages.create
  • chat.messages
  • chat.import
Télécharger des contenus multimédias Avec l'authentification des utilisateurs:
  • chat.messages.readonly
  • chat.messages
Avec l'authentification des applications:
  • chat.bot
Recevoir une pièce jointe Avec l'authentification des applications:
  • chat.bot
États de lecture par l'utilisateur
Obtenir l'état de lecture d'un espace utilisateur Avec l'authentification des utilisateurs:
  • chat.users.readstate
  • chat.users.readstate.readonly
Mettre à jour l'état de lecture d'un espace utilisateur Avec l'authentification des utilisateurs:
  • chat.users.readstate
Obtenir l'état de lecture d'un fil de discussion d'un utilisateur Avec l'authentification des utilisateurs:
  • chat.users.readstate
  • chat.users.readstate.readonly
Événements de l'espace
Recevoir les événements de l'espace Avec l'authentification des utilisateurs:
  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
Répertorier les événements de l'espace Avec l'authentification des utilisateurs:
  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly

Pour les événements d'interaction avec l'application Chat

Le tableau suivant liste les interactions courantes des utilisateurs avec les applications Chat, et indique si une authentification est requise ou compatible:

Scénario Aucune authentification requise Compatible avec l'authentification des utilisateurs Compatibilité avec l'authentification des applications
Recevoir des messages de:
Événements d'interaction avec l'application Chat
Rappels Apps Script
Google Cloud Pub/Sub
Répondre aux messages:
De manière synchrone, à l'aide d'un événement d'interaction avec l'application Chat
De manière synchrone, en utilisant une valeur de retour de rappel Apps Script
Pour envoyer de nouveaux messages:
Avec des webhooks entrants