API Directory: membres du groupe
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ajouter un membre à un groupe
Pour ajouter un membre à un groupe, utilisez la requête POST suivante et incluez l'autorisation décrite dans la section Autoriser les requêtes. Un membre de groupe peut être un utilisateur ou un autre groupe. groupKey correspond à l'adresse e-mail du groupe du nouveau membre ou à l'id unique du groupe. Pour en savoir plus sur les propriétés de requête et de réponse, consultez la documentation de référence de l'API:
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
Si vous ajoutez un groupe en tant que membre d'un autre groupe, il peut s'écouler jusqu'à 10 minutes avant que les membres du sous-groupe ne s'affichent en tant que membres du groupe parent. De plus, l'API renvoie une erreur pour les cycles dans les appartenances aux groupes. Par exemple, si le groupe 1 est membre du groupe 2, le groupe 2 ne peut pas être membre du groupe 1.
Requête JSON
La requête JSON suivante montre un exemple de corps de requête qui crée un membre de groupe. Son adresse e-mail est liz@example.com et son rôle dans le groupe est MEMBER. La requête POST utilise NNNNN pour groupKey:
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members
{
"email": "liz@example.com",
"role": "MEMBER"
}
L'role d'un membre de groupe peut être:
OWNER : ce rôle permet d'envoyer des messages au groupe, d'ajouter ou de supprimer des membres, de modifier les rôles des membres, de modifier les paramètres du groupe et de le supprimer. Un OWNER doit être membre du groupe.
MANAGER : ce rôle n'est disponible que si Google Workspace est activé à l'aide de la console d'administration. Un rôle GESTIONNAIRE peut faire tout ce qu'un rôle PROPRIÉTAIRE peut faire, sauf désigner un membre comme PROPRIÉTAIRE ou supprimer le groupe. Un groupe peut avoir plusieurs membres de type PROPRIÉTAIRE et GESTIONNAIRE.
MEMBER : ce rôle permet de s'abonner à un groupe, de consulter les archives de discussions et la liste des membres du groupe. Pour en savoir plus sur les rôles de membre, consultez le Centre d'aide pour les administrateurs.
Réponse JSON
Une réponse réussie renvoie un code d'état HTTP 200 et les informations d'adhésion du membre. id correspond à l'ID d'adhésion unique du membre:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MEMBER",
"type": "GROUP"
}
L'type d'un membre de groupe peut être:
GROUP : le membre est un autre groupe.MEMBER : le membre est un utilisateur
Modifier l'appartenance à un groupe
Pour modifier l'appartenance à un groupe, utilisez la requête PUT suivante et incluez l'autorisation décrite dans la section Autoriser les requêtes. groupKey correspond à l'adresse e-mail du groupe ou à son id unique, et memberKey à l'adresse e-mail principale de l'utilisateur ou du groupe, à l'adresse e-mail d'alias de l'utilisateur ou à son id unique. Pour en savoir plus sur les propriétés de requête et de réponse, consultez la documentation de référence de l'API:
PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Requête JSON
La requête JSON suivante montre un exemple de corps de requête qui met à jour les paramètres d'appartenance à un groupe. Son adresse e-mail est liz@example.com, et son rôle dans le groupe est passé de MEMBER à MANAGER. Dans cet exemple, le groupKey de la requête PUT est NNNNN. Pour en savoir plus sur les rôles MEMBRE, PROPRIÉTAIRE et GESTIONNAIRE, consultez le Centre d'aide de l'administration:
PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
{
"email": "liz@example.com",
"role": "MANAGER"
}
Réponse JSON
Une réponse réussie renvoie un code d'état HTTP 200 et les informations d'abonnement mises à jour. id correspond à l'ID d'adhésion unique du membre:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
Récupérer un membre d'un groupe
Pour récupérer l'appartenance à un groupe, utilisez la requête GET suivante et incluez l'autorisation décrite dans Autoriser les requêtes. groupKey correspond à l'adresse e-mail du groupe ou à son id unique, et memberKey à l'adresse e-mail principale de l'utilisateur ou du groupe, à l'adresse e-mail d'alias de l'utilisateur ou à son id unique. Pour en savoir plus sur les propriétés de requête et de réponse, consultez la documentation de référence de l'API:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Réponse JSON
Une réponse réussie renvoie un code d'état HTTP 200 et les informations d'adhésion du membre. id correspond à l'ID d'adhésion unique du membre:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
Récupérer tous les membres du groupe
Pour récupérer tous les membres du groupe, utilisez la requête GET suivante et incluez l'autorisation décrite dans Autoriser les requêtes. groupKey correspond à l'adresse e-mail du groupe ou à son id unique. La chaîne de requête roles facultative est un filtre qui vous permet de récupérer les membres d'un groupe par rôle. Les collections de rôles qui en résultent sont triées dans l'ordre indiqué dans le filtre roles. Pour en savoir plus sur les propriétés de requête et de réponse, consultez la documentation de référence de l'API. Des retours à la ligne ont été inclus dans cet exemple pour le rendre plus lisible:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
?pageToken=pagination token
&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma
&maxResults=maximum results per response page
Tous les membres sont renvoyés par ordre alphabétique de leurs adresses e-mail. Utilisez également la chaîne de requête pageToken pour les réponses comportant un grand nombre de membres. En cas de pagination, la réponse renvoie la propriété nextPageToken, qui contient un jeton pour la page suivante de résultats de la réponse. Votre prochaine requête utilise ce jeton comme valeur de la chaîne de requête pageToken.
Réponse JSON
Une réponse réussie renvoie un code d'état HTTP 200 et la liste des informations sur les membres. id correspond à l'ID d'adhésion unique du membre. Cette réponse contient un nextPageToken pour la liste de suivi des membres du groupe:
{
"kind": "directory#members",
"members": [
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "USER"
},
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "radhe@example.com",
"role": "MANAGER",
"type": "USER"
}
],
"nextPageToken": "NNNNN"
}
Supprimer l'appartenance à un groupe
Pour supprimer l'appartenance d'un membre à un groupe, utilisez la requête DELETE suivante et incluez l'autorisation décrite dans la section Autoriser les requêtes. groupKey correspond à l'id unique du groupe, et memberKey à l'adresse e-mail principale de l'utilisateur ou du membre du groupe supprimé, ou à l'id unique de l'utilisateur. Pour en savoir plus sur les propriétés de requête et de réponse, consultez la documentation de référence de l'API :
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Par exemple, cette requête DELETE supprime le membre dont groupKey est nnn et dont memberKey est l'adresse e-mail principale de l'utilisateur, liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com
Une réponse réussie renvoie un code d'état HTTP 200.
Lorsqu'un membre est supprimé:
- Les membres que vous supprimez ne reçoivent plus les e-mails adressés au groupe.
- La suppression d'un membre d'un groupe ne supprime pas le compte de l'utilisateur.
- Si vous supprimez le propriétaire d'un groupe, le groupe continue de fonctionner normalement. En tant qu'administrateur, vous pouvez gérer le groupe vous-même ou en transférer la propriété à un autre membre du groupe.
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/08/29 (UTC).
[null,null,["Dernière mise à jour le 2025/08/29 (UTC)."],[],[],null,["# Directory API: Group Members\n\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 1. [Add a member to a group](#create_member) 2. [Update a group membership](#update_member) 3. [Retrieve a group's member](#get_member) 4. [Retrieve all group members](#get_all_members) 5. [Delete membership in a group](#delete_member) |\n\nAdd a member to a group\n-----------------------\n\nTo add a member to a group, use the following `POST` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). A group member can be a user or another group. The `groupKey` is the new member's group email address or the group's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/insert): \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n```\n\nIf you add a group as a member of another group, there may be a delay of up to 10 minutes before the child group's members appear as members of the parent group. In addtion, the API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1.\n\n### JSON request\n\nThe following JSON request shows a sample request body that creates a group member. The member's email address is liz@example.com and the member's role in the group is as a `MEMBER`. The `POST` request uses NNNNN for the `groupKey`: \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\"\n}\n```\n\nA group member's `role` can be:\n\n- `OWNER` -- This role can change send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An `OWNER` must be a member of the group.\n- `MANAGER` -- This role is only available if the Google Workspace is enabled using the Admin console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple OWNER and MANAGER members.\n- `MEMBER` -- This role can subscribe to a group, view discussion archives, and view the group's membership list. For more information about member roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094).\n\n\u003cbr /\u003e\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\",\n \"type\": \"GROUP\"\n }\n```\n\nA group member's `type` can be:\n\n- `GROUP` -- The member is another group.\n- `MEMBER` -- The member is a user\n\n\u003cbr /\u003e\n\nUpdate a group membership\n-------------------------\n\nTo update a group membership, use the following `PUT` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/update): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n| **Note:** The API also supports the [patch semantics](/workspace/admin/directory/v1/guides/performance#patch).\n\n### JSON request\n\nThe following JSON request shows a sample request body that updates a group membership settings. The member's email address is liz@example.com and the member's role in the group is changed from a `MEMBER` to a `MANAGER`. The `PUT` request's `groupKey` in this example is NNNNN. For information about the MEMBER, OWNER and MANAGER roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\"\n}\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the updated membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve a group's member\n-------------------------\n\nTo retrieve a group membership, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/get): \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve all group members\n--------------------------\n\nTo retrieve all group members, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`. The optional `roles` query string is a filter allowing you to retrieve group members by role and the resulting role collections are in the order given in the `roles` filter. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/list). For readability, this example uses line returns: \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n?pageToken=pagination token\n&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma\n&maxResults=maximum results per response page\n```\n\nAll members are returned in the alphabetical order of the members' email addresses. And use the `pageToken` query string for responses with large number of members. In the case of pagination, the response returns the `nextPageToken` property which has a token for the next page of response results. Your next request uses this token as the `pageToken` query string value.\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the list of member information. The `id` is the member's unique membership ID. There is a `nextPageToken` for the follow-on list of group members in this response: \n\n```carbon\n{\n \"kind\": \"directory#members\",\n \"members\": [\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n },\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"radhe@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n }\n ],\n \"nextPageToken\": \"NNNNN\"\n}\n```\n\nDelete membership in a group\n----------------------------\n\nTo delete a member's membership in a group, use the following `DELETE` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's unique `id`, and `memberKey` is the deleted user or group member's primary email address or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/delete).: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\nFor example, this `DELETE` request deletes the member whose `groupKey` is nnn and whose `memberKey` is the user's primary email address, liz@example.com: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com\n```\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes).\n\nWhen a member is deleted:\n\n- Members you remove no longer receive email addressed to the group.\n- Removing a member from a group does not delete the user's account.\n- If you delete the group owner, the group still works normally. As an administrator, you can manage the group or assign ownership to another group member\n\n\u003cbr /\u003e"]]
