Method: members.list

Récupère une liste paginée de tous les membres d'un groupe. Cette méthode expire au bout de 60 minutes. Pour en savoir plus, consultez la section Résoudre les codes d'erreur.

Requête HTTP

GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
groupKey

string

Identifie le groupe dans la requête API. La valeur peut être l'adresse e-mail, l'alias ou l'ID unique du groupe.

Paramètres de requête

Paramètres
includeDerivedMembership

boolean

Indique si les adhésions indirectes doivent être listées. Valeur par défaut : "false".

maxResults

integer

Nombre maximal de résultats sur une page. La valeur maximale autorisée est de 200.

pageToken

string

Jeton permettant de spécifier la page suivante de la liste.

roles

string

Le paramètre de requête roles vous permet de récupérer les membres du groupe par rôle. Les valeurs autorisées sont OWNER, MANAGER et MEMBER.

Corps de la requête

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

Corps de la réponse

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

Représentation JSON
{
  "kind": string,
  "etag": string,
  "members": [
    {
      object (Member)
    }
  ],
  "nextPageToken": string
}
Champs
kind

string

Type de ressource

etag

string

ETag de la ressource.

members[]

object (Member)

Liste d'objets de membres.

nextPageToken

string

Jeton utilisé pour accéder à la page suivante de ce résultat.

Champs d'application des autorisations

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

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.member
  • https://www.googleapis.com/auth/admin.directory.group.member.readonly
  • https://www.googleapis.com/auth/admin.directory.group.readonly

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