Method: members.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Method: members.list\n\nRetrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------|\n| `groupKey` | `string` Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. |\n\n### Query parameters\n\n| Parameters ||\n|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| `includeDerivedMembership` | `boolean` Whether to list indirect memberships. Default: false. |\n| `maxResults` | `integer` Maximum number of results to return. Max allowed value is 200. |\n| `pageToken` | `string` Token to specify next page in the list. |\n| `roles` | `string` The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"members\": [ { object (/workspace/admin/directory/reference/rest/v1/members#Member) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `members[]` | `object (`[Member](/workspace/admin/directory/reference/rest/v1/members#Member)`)` A list of member objects. |\n| `nextPageToken` | `string` Token used to access next page of this result. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/groups/`\n- `\n https://www.googleapis.com/auth/admin.directory.group`\n- `\n https://www.googleapis.com/auth/admin.directory.group.member`\n- `\n https://www.googleapis.com/auth/admin.directory.group.member.readonly`\n- `\n https://www.googleapis.com/auth/admin.directory.group.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]