Method: spaces.members.list

Répertorie les membres d'un espace. Pour obtenir un exemple, consultez Lister les utilisateurs et les applications Google Chat dans un espace. La liste des membres avec authentification de l'application répertorie les membres des espaces auxquels l'application Chat a accès, mais exclut les membres de l'application Chat, y compris les siens. La liste des abonnements avec l'authentification des utilisateurs répertorie les abonnements aux espaces auxquels l'utilisateur authentifié a accès.

Les types d'authentification suivants sont acceptés :

  • Authentification de l'application avec l'un des niveaux d'autorisation suivants :

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
    • L'authentification des utilisateurs accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, useAdminAccess est true et que l'un des niveaux d'autorisation suivants est utilisé :
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

Requête HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource de l'espace pour lequel extraire une liste de membres.

Format : spaces/{space}

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal de membres à afficher. Le service peut renvoyer un nombre inférieur à cette valeur.

Si aucune valeur n'est spécifiée, 100 souscriptions au maximum sont renvoyées.

La valeur maximale est de 1 000. Si vous utilisez une valeur supérieure à 1 000, elle est automatiquement remplacée par 1 000.

Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.
pageToken

string

Facultatif. Jeton de page reçu d'un appel précédent pour lister les abonnements. Fournissez ce paramètre pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel ayant fourni le jeton de page. Si vous transmettez des valeurs différentes aux autres paramètres, vous risquez d'obtenir des résultats inattendus.
filter

string

Facultatif. Filtre de requête.

Vous pouvez filtrer les membres par rôle (role) et par type (member.type).

Pour filtrer par rôle, définissez role sur ROLE_MEMBER ou ROLE_MANAGER.

Pour filtrer par type, définissez member.type sur HUMAN ou BOT. Vous pouvez également filtrer member.type à l'aide de l'opérateur !=.

Pour filtrer à la fois par rôle et par type, utilisez l'opérateur AND. Pour filtrer par rôle ou par type, utilisez l'opérateur OR.

member.type = "HUMAN" ou member.type != "BOT" est obligatoire lorsque useAdminAccess est défini sur "true". Les autres filtres de type de membre seront refusés.

Par exemple, les requêtes suivantes sont valides :

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Les requêtes suivantes ne sont pas valides :

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.
showGroups

boolean

Facultatif. Lorsque true, renvoie également les souscriptions associées à un Google Group, en plus des autres types de souscriptions. Si une filter est définie, les abonnements Google Group qui ne correspondent pas aux critères de filtre ne sont pas renvoyés.
showInvited

boolean

Facultatif. Lorsque la valeur est true, renvoie également les souscriptions associées aux membres invited, en plus des autres types de souscriptions. Si un filtre est défini, les abonnements invited qui ne correspondent pas aux critères du filtre ne sont pas renvoyés.

Nécessite actuellement une authentification de l'utilisateur.
useAdminAccess

boolean

Facultatif. Lorsque la valeur est true, la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur qui appelle doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces".

Nécessite le champ d'application OAuth 2.0 chat.admin.memberships.readonly ou chat.admin.memberships.

Il n'est pas possible de lister les abonnements aux applications dans un espace lorsque vous utilisez l'accès administrateur.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse à la liste des membres de l'espace.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
Champs
memberships[]

object (Membership)

Liste à puces. Liste des abonnements sur la page demandée (ou la première page).
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, il n'y a pas d'autres pages.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Pour en savoir plus, consultez le guide d'autorisation.