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

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

Présentation du processus

Le schéma suivant illustre les étapes d'authentification et d'autorisation de Google Chat:

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

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

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

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

  4. Demander le consentement:si votre application s'authentifie en tant qu'utilisateur, Google affiche un écran de consentement OAuth pour que l'utilisateur puisse décider d'autoriser ou non votre application à accéder aux données demandées. L'authentification avec un compte de service ne nécessite pas l'autorisation de l'utilisateur.

  5. Envoyer une requête approuvée pour les ressources:si l'utilisateur accepte les champs d'application, votre application regroupe les identifiants et les champs approuvés par l'utilisateur 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:le jeton d'accès contient une liste des champs d'application 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 aux ressources de l'API Chat.

  8. Obtenir un jeton d'actualisation (facultatif) : si votre application doit accéder à l'API Google Chat au-delà de la durée de vie d'un seul jeton d'accès, elle peut obtenir un jeton d'actualisation. Pour en savoir plus, consultez la section 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 d'accorder de nouveaux champs d'application, ce qui génère une nouvelle requête pour obtenir un jeton d'accès (étapes 3 à 6).

Quand les applications Chat nécessitent une authentification

Les applications Chat peuvent envoyer des messages en réponse à une interaction utilisateur ou de manière asynchrone. Ils peuvent également effectuer des tâches en son nom, comme créer un espace Chat ou obtenir la liste des personnes dans un espace Chat.

Les applications Chat n'ont pas besoin d'authentification pour répondre à une interaction utilisateur, sauf si l'application Chat appelle l'API Chat ou une autre API Google lors du traitement d'une réponse.

Pour envoyer des messages asynchrones ou effectuer des tâches au nom d'un utilisateur, les applications Chat envoient des requêtes REST à l'API Chat, qui nécessitent 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 en tant qu'utilisateur ou application Chat pour recevoir et répondre de manière synchrone aux événements d'interaction.

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

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

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

Aucune autorisation requise pour les événements d'interaction avec l'application Chat
Figure 2 : Les événements d'interaction de 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 événement d'interaction avec l'application Chat.

Authentification requise pour les messages asynchrones

Des messages asynchrones se produisent lorsqu'une application Chat envoie une requête à l'API Chat, ce qui nécessite une authentification et une autorisation.

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

  • Créez un espace Chat dédié à l'étude et à la résolution de l'indisponibilité.
  • Ajoutez des personnes à l'espace Chat.
  • Publiez un message dans l'espace Chat pour donner des informations sur l'indisponibilité.

Le schéma suivant illustre une séquence de messages asynchrone entre une application Chat et un 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 l'API Chat à l'aide de la méthode spaces.messages.create et inclut les identifiants utilisateur dans la requête HTTP.
  2. Google Chat authentifie l'application Chat à l'aide d'un compte de service ou d'identifiants utilisateur.
  3. Google Chat affiche le message de l'application dans un espace Chat spécifié.

Champs d'application des API Chat

Configurez l'écran de consentement OAuth et choisissez des autorisations pour définir les informations qui s'affichent auprès des utilisateurs et des examinateurs de l'application, et enregistrez 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 champs d'application de l'autorisation. Un champ d'application de l'autorisation est une chaîne d'URI OAuth 2.0 qui contient le nom de l'application Google Workspace, le type de données auxquelles elle accède et le niveau d'accès.

Champs d'application non sensibles

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

Permet aux applications Chat d'afficher les chats et d'envoyer des messages.

Ce champ d'application n'est compatible qu'avec l'authentification des applications avec des comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec une délégation au niveau du domaine à l'aide de ce champ d'application.

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 voir ou modifier les métadonnées (y compris les 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 Afficher les discussions 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 Afficher les participants aux 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 Afficher, ajouter et supprimer des réactions à des 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 Afficher et modifier 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 Afficher, ajouter, modifier et supprimer les participants et les administrateurs dans les conversations appartenant au domaine de l'administrateur dans Chat
https://www.googleapis.com/auth/chat.app.spaces

Créer des conversations et des espaces, et afficher ou modifier les métadonnées (y compris les paramètres d'historique et d'accès) dans Chat Nécessite l'approbation d'un administrateur.

Ce champ d'application n'est compatible qu'avec l'authentification des applications avec des comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec une délégation au niveau du domaine à l'aide de ce champ d'application.

https://www.googleapis.com/auth/chat.app.spaces.create

Créer des conversations et des espaces dans Chat Nécessite l'approbation de l'administrateur.

Ce champ d'application n'est compatible qu'avec l'authentification des applications avec des comptes de service. Vous ne pouvez pas vous authentifier à l'aide d'identifiants utilisateur ou d'une délégation au niveau du domaine utilisant ce champ d'application.

https://www.googleapis.com/auth/chat.app.memberships

Afficher les participants aux conversations et aux espaces dans Chat, en ajouter, les modifier ou en supprimer Nécessite l'approbation de l'administrateur.

Ce champ d'application n'accepte que l'authentification des applications avec les comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec une délégation au niveau du domaine à l'aide de ce champ d'application.

https://www.googleapis.com/auth/chat.customemojis Affichez, créez et supprimez des emoji personnalisés dans Chat.
https://www.googleapis.com/auth/chat.customemojis.readonly Affichez les emoji personnalisés dans Chat.
https://www.googleapis.com/auth/chat.users.spacesettings Afficher et modifier les paramètres de l'espace utilisateur Chat

Voir les API des paramètres utilisateur de l'espace: getSpaceNotificationSetting, updateSpaceNotificationSetting

Champs d'application restreints

Code de 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 Importez des espaces, des messages et des membres dans Chat. 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 les messages, et ajouter, afficher et supprimer les 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
https://www.googleapis.com/auth/chat.app.delete

supprimer des conversations et des espaces, et supprimer l'accès aux fichiers associés dans Chat. Nécessite l'approbation de l'administrateur.

Ce champ d'application n'accepte que l'authentification des applications avec les comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec une délégation au niveau du domaine à l'aide de ce champ d'application.

Les champs d'application des tableaux précédents indiquent leur sensibilité, conformément aux définitions suivantes:

Si votre application nécessite l'accès à d'autres API Google, vous pouvez également ajouter ces champs d'application. Pour en savoir plus sur les champs d'application des API Google, consultez la section Utiliser OAuth 2.0 pour accéder aux API Google.

Pour en savoir plus sur les habilitations des API Google Workspace, consultez la page Configurer l'écran de consentement OAuth et choisir des habilitations.

Types d'authentification requis

Les applications Chat peuvent s'authentifier et autoriser l'accès avec l'API Chat de deux façons:

Authentification des utilisateurs
Authentification des utilisateurs : permet à une application Chat d'accéder aux données utilisateur et d'effectuer des actions au nom de l'utilisateur. Les champs d'application OAuth spécifient les données et les actions autorisées. Sauf si l'application Chat a été installée par un administrateur ou a reçu une délégation au niveau du domaine, la première fois que l'application Chat effectue une action au nom d'un utilisateur, celui-ci doit l'autoriser à l'aide de l'écran d'autorisation OAuth.
Authentification de l'application

L'authentification de l'application permet à une application Chat d'utiliser les identifiants d'un compte de service, d'accéder aux données et d'effectuer des actions comme elle-même. Étant donné que l'application Chat utilise ses propres identifiants pour accéder aux ressources et les utiliser, les utilisateurs finaux n'ont pas besoin d'approuver les appels d'API de l'application Chat. Vous ne pouvez pas ajouter de champs d'autorisation OAuth compatibles avec l'autorisation d'application à l'écran d'autorisation OAuth.

Deux types de champs d'application d'autorisation OAuth sont compatibles avec l'authentification des applications:

  • https://www.googleapis.com/auth/chat.bot : votre application Chat peut appeler des méthodes de l'API Google Chat compatibles avec ce niveau d'autorisation pour créer, mettre à jour, obtenir, répertorier ou supprimer les ressources auxquelles elle a accès, comme les messages des espaces auxquels les utilisateurs finaux ajoutent votre application Chat. Votre application Chat peut s'accorder elle-même cette portée d'autorisation, sans autorisation d'administrateur ni d'utilisateur final.
  • https://www.googleapis.com/auth/chat.app.* (Preview développeur) : l'utilisation de ces champs d'application nécessite une approbation unique de l'administrateur. Pour obtenir l'approbation de l'administrateur, vous devez préparer le compte de service de l'application Chat à recevoir l'approbation de l'administrateur en créant un client OAuth compatible avec Google Workspace Marketplace et en configurant l'application dans le SDK Google Workspace Marketplace. Ces habilitations permettent à votre application Chat d'appeler des méthodes spécifiques de l'API Google Chat. Par exemple, chat.app.spaces.create permet aux applications de créer des espaces Chat.

Si une méthode est compatible à la fois avec l'authentification de l'utilisateur et de l'application, l'API Chat renvoie différents résultats en fonction du type d'authentification que vous utilisez :

  • Avec l'authentification de l'application, les méthodes ne renvoient que les ressources auxquelles l'application Chat peut accéder.
  • Avec l'authentification de l'utilisateur, les méthodes ne renvoient que les ressources auxquelles l'utilisateur peut accéder.

Par exemple, l'appel de la méthode spaces.list() avec l'autorisation de l'application renvoie la liste des espaces auxquels l'application Chat est membre. Appeler spaces.list() avec l'autorisation de l'utilisateur renvoie la liste des espaces dont l'utilisateur est membre. En pratique, vous pouvez utiliser les deux types d'authentification lorsque vous appelez l'API Chat, en fonction de la conception et des fonctionnalités de votre application Chat.

Pour les appels d'API Chat asynchrones

Le tableau suivant répertorie les méthodes de l'API Chat et les portées d'autorisation compatibles:

Méthode Authentification des utilisateurs compatible Compatibilité avec l'authentification des applications Champs d'application des autorisations compatibles
Espaces  
Créer un espace Avec Authentification des utilisateurs :
  • chat.spaces.create
  • chat.spaces
  • chat.import
Avec l'authentification des applications et l'approbation de l'administrateur (disponible en Preview développeur) :
  • chat.app.spaces.create
  • chat.app.spaces
Configurer un espace Avec l'authentification des utilisateurs :
  • chat.spaces.create
  • chat.spaces
Obtenir un espace Avec Authentification des utilisateurs :
  • chat.spaces.readonly
  • chat.spaces
Avec l'authentification des utilisateurs à l'aide de droits d'administrateur :
  • chat.admin.spaces.readonly
Avec l'authentification de l'application :
  • chat.bot
Avec l'authentification des applications et l'approbation de l'administrateur (disponible en Preview développeur) :
  • chat.app.spaces
Lister les espaces Avec l'authentification des utilisateurs :
  • chat.spaces.readonly
  • chat.spaces
Avec l'authentification de l'application :
  • chat.bot
Espaces de recherche Avec l'authentification des utilisateurs à l'aide de droits d'administrateur :
  • chat.admin.spaces.readonly
Mettre à jour un espace Avec Authentification des utilisateurs :
  • chat.spaces
  • chat.import
Avec l'authentification des utilisateurs à l'aide de droits d'administrateur :
  • chat.admin.spaces
Avec l'authentification des applications et l'approbation de l'administrateur (disponible en Preview développeur) :
  • chat.app.spaces
Supprimer un espace Avec l'authentification des utilisateurs :
  • chat.delete
  • chat.import
Avec l'authentification des utilisateurs à l'aide de droits d'administrateur :
  • chat.admin.delete
Avec l'authentification des applications et l'approbation de l'administrateur (disponible en Preview développeur) :
  • chat.app.delete
Finaliser 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 de l'application :
  • chat.bot
Membres  
Créer un membre Avec l'authentification des utilisateurs :
  • chat.memberships
  • chat.memberships.app
  • chat.import
Avec l'authentification des utilisateurs à l'aide de droits d'administrateur :
  • chat.admin.memberships
Avec l'authentification des applications et l'approbation de l'administrateur (disponible en Preview développeur) :
  • chat.app.memberships
Obtenir un membre Avec Authentification des utilisateurs :
  • chat.memberships.readonly
  • chat.memberships
Avec l'authentification de l'application :
  • chat.bot
Avec l'authentification des utilisateurs à l'aide de droits d'administrateur :
  • chat.admin.memberships.readonly
Lister les membres Avec l'authentification des utilisateurs :
  • chat.memberships.readonly
  • chat.memberships
  • chat.import
Avec l'authentification des applications :
  • chat.bot
Avec l'authentification des utilisateurs par le biais de droits d'administrateur :
  • chat.admin.memberships.readonly
Supprimer un membre Avec Authentification des utilisateurs :
  • chat.memberships
  • chat.memberships.app
  • chat.import
Avec l'authentification des utilisateurs à l'aide de droits d'administrateur :
  • chat.admin.memberships
Avec authentification des applications et approbation de l'administrateur (disponible dans la Preview développeur) :
  • chat.app.memberships
Modifier un membre Avec l'authentification des utilisateurs :
  • chat.memberships
  • chat.import
Avec l'authentification des utilisateurs à l'aide de droits d'administrateur :
  • chat.admin.memberships
Avec l'authentification des applications et l'approbation de l'administrateur (disponible en Preview développeur) :
  • chat.app.memberships
Messages  
Créer un message Avec l'authentification des utilisateurs :
  • chat.messages.create
  • chat.messages
  • chat.import
Avec l'authentification de l'application :
  • chat.bot
Récupérer 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 de l'application :
  • chat.bot
Supprimer un message Avec l'authentification des utilisateurs :
  • chat.messages
  • chat.import
Avec l'authentification de l'application :
  • chat.bot
Réactions  
Créer une réaction Avec 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
Emoji personnalisés  
Créer un emoji personnalisé Avec Authentification des utilisateurs :
  • chat.customemojis
Supprimer un emoji personnalisé Avec Authentification des utilisateurs :
  • chat.customemojis
Obtenir un emoji personnalisé Avec l'authentification des utilisateurs :
  • chat.customemojis
  • chat.customemojis.readonly
Lister les emoji personnalisés Avec l'authentification des utilisateurs :
  • chat.customemojis
  • chat.customemojis.readonly
Contenus multimé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 de l'application :
  • chat.bot
Recevoir une pièce jointe Avec l'authentification de l'application :
  • chat.bot
États de lecture par l'utilisateur
Obtenir l'état de lecture de l'espace d'un utilisateur Avec l'authentification des utilisateurs :
  • chat.users.readstate
  • chat.users.readstate.readonly
Modifier l'état de lecture d'un espace pour un utilisateur Avec l'authentification des utilisateurs :
  • chat.users.readstate
Obtenir l'état de lecture d'un fil de discussion pour un utilisateur Avec l'authentification des utilisateurs :
  • chat.users.readstate
  • chat.users.readstate.readonly
Paramètres de l'espace utilisateur
Obtenir le paramètre de notification d'un espace pour un utilisateur Avec l'authentification des utilisateurs :
  • chat.users.spacesettings
Modifier le paramètre de notification d'un espace pour un utilisateur Avec l'authentification des utilisateurs :
  • chat.users.spacesettings
Événements spatiaux
Obtenir les événements de l'espace Avec l'authentification des utilisateurs, vous devez utiliser un champ d'application basé sur le type d'événement :
  • Pour les événements liés aux messages :
    • chat.messages
    • chat.messages.readonly
  • Pour les événements liés aux réactions :
    • chat.messages.reactions
    • chat.messages.reactions.readonly
    • chat.messages
    • chat.messages.readonly
  • Pour les événements liés aux souscriptions:
    • chat.memberships
    • chat.memberships.readonly
  • Pour les événements concernant l'espace :
    • chat.spaces
    • chat.spaces.readonly
Lister les événements d'espace Avec l'authentification des utilisateurs, vous devez utiliser une portée pour chaque type d'événement inclus dans la requête :
  • Pour les événements liés aux messages :
    • chat.messages
    • chat.messages.readonly
  • Pour les événements liés aux réactions :
    • chat.messages.reactions
    • chat.messages.reactions.readonly
    • chat.messages
    • chat.messages.readonly
  • Pour les événements liés aux souscriptions:
    • chat.memberships
    • chat.memberships.readonly
  • Pour les événements concernant l'espace:
    • chat.spaces
    • chat.spaces.readonly

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

Le tableau suivant répertorie les méthodes courantes d'interaction des utilisateurs avec les applications Chat, et indique si l'authentification est requise ou compatible:

Scénario Aucune authentification requise Authentification des utilisateurs compatible Compatibilité avec l'authentification des applications
Recevoir des messages de:
Événements d'interaction avec l'application Chat
Appels de rappel 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
Envoyer de nouveaux messages :
Avec des webhooks entrants