Directory API: Gruppenmitglieder
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Einer Gruppe ein Mitglied hinzufügen
Wenn Sie einer Gruppe ein Mitglied hinzufügen möchten, verwenden Sie die folgende POST-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. Ein Gruppenmitglied kann ein Nutzer oder eine andere Gruppe sein. groupKey ist die E-Mail-Adresse der Gruppe des neuen Mitglieds oder die eindeutige id der Gruppe. Informationen zu den Anfrage- und Antworteigenschaften finden Sie in der API-Referenz:
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
Wenn Sie eine Gruppe als Mitglied einer anderen Gruppe hinzufügen, kann es bis zu 10 Minuten dauern, bis die Mitglieder der untergeordneten Gruppe als Mitglieder der übergeordneten Gruppe angezeigt werden. Außerdem gibt die API einen Fehler für Zyklen in Gruppenmitgliedschaften zurück. Wenn beispielsweise Gruppe 1 Mitglied von Gruppe 2 ist, kann Gruppe 2 kein Mitglied von Gruppe 1 sein.
JSON-Anfrage
Die folgende JSON-Anfrage zeigt einen Beispiel-Anfragetext, mit dem ein Gruppenmitglied erstellt wird. Die E-Mail-Adresse des Mitglieds lautet liz@beispiel.de und seine Rolle in der Gruppe ist MEMBER. In der POST-Anfrage wird NNNNN für die groupKey verwendet:
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members
{
"email": "liz@example.com",
"role": "MEMBER"
}
Die role eines Gruppenmitglieds kann Folgendes sein:
OWNER: Mit dieser Rolle können Nachrichten an die Gruppe gesendet, Mitglieder hinzugefügt oder entfernt, Mitgliedsrollen geändert, die Einstellungen der Gruppe geändert und die Gruppe gelöscht werden. Ein OWNER muss Mitglied der Gruppe sein.
MANAGER: Diese Rolle ist nur verfügbar, wenn Google Workspace über die Admin-Konsole aktiviert ist. Nutzer mit der Rolle „Manager“ können alle Aktionen ausführen, die auch Inhaber ausführen können, mit der Ausnahme, dass sie andere Mitglieder nicht zum Inhaber machen und die Gruppe nicht löschen können. Eine Gruppe kann mehrere Inhaber und Manager haben.
MEMBER: Mit dieser Rolle können Gruppen abonniert, Diskussionsarchive aufgerufen und die Mitgliederliste der Gruppe eingesehen werden. Weitere Informationen zu Mitgliedsrollen finden Sie in der Verwaltungshilfe.
JSON-Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die Mitgliedschaftsinformationen des Mitglieds zurückgegeben. Die id ist die eindeutige Mitglieds-ID des Mitglieds:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MEMBER",
"type": "GROUP"
}
Die type eines Gruppenmitglieds kann Folgendes sein:
GROUP – Das Mitglied ist eine andere Gruppe.MEMBER – Das Mitglied ist ein Nutzer
Gruppenmitgliedschaft aktualisieren
Wenn Sie eine Gruppenmitgliedschaft aktualisieren möchten, verwenden Sie die folgende PUT-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. groupKey ist die E-Mail-Adresse der Gruppe oder die eindeutige id der Gruppe. memberKey ist die primäre E-Mail-Adresse des Nutzers oder der Gruppe, die Alias-E-Mail-Adresse eines Nutzers oder die eindeutige id des Nutzers. Informationen zu den Anfrage- und Antworteigenschaften finden Sie in der API-Referenz:
PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
JSON-Anfrage
Die folgende JSON-Anfrage zeigt einen Beispiel-Anfragetext, mit dem die Einstellungen für die Gruppenmitgliedschaft aktualisiert werden. Die E-Mail-Adresse des Mitglieds lautet liz@beispiel.de und seine Rolle in der Gruppe wird von MEMBER in MANAGER geändert. Die groupKey der PUT-Anfrage in diesem Beispiel ist NNNNN. Informationen zu den Rollen „MITGLIED“, „INHABER“ und „MANAGER“ finden Sie in der Verwaltungshilfe:
PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
{
"email": "liz@example.com",
"role": "MANAGER"
}
JSON-Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die aktualisierten Mitgliedschaftsinformationen zurückgegeben. Die id ist die eindeutige Mitglieds-ID des Mitglieds:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
Gruppenmitglieder abrufen
Wenn Sie eine Gruppenmitgliedschaft abrufen möchten, verwenden Sie die folgende GET-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. groupKey ist die E-Mail-Adresse der Gruppe oder die eindeutige id der Gruppe. memberKey ist die primäre E-Mail-Adresse des Nutzers oder der Gruppe, die Alias-E-Mail-Adresse eines Nutzers oder die eindeutige id des Nutzers. Informationen zu den Anfrage- und Antworteigenschaften finden Sie in der API-Referenz:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
JSON-Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die Mitgliedschaftsinformationen des Mitglieds zurückgegeben. Die id ist die eindeutige Mitglieds-ID des Mitglieds:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
Alle Gruppenmitglieder abrufen
Wenn Sie alle Gruppenmitglieder abrufen möchten, verwenden Sie die folgende GET-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. groupKey ist die E-Mail-Adresse oder die eindeutige id der Gruppe. Der optionale roles-Suchstring ist ein Filter, mit dem Sie Gruppenmitglieder nach Rolle abrufen können. Die resultierenden Rollensammlungen werden in der im roles-Filter angegebenen Reihenfolge zurückgegeben. Informationen zu den Anfrage- und Antworteigenschaften finden Sie in der API-Referenz. Zur besseren Lesbarkeit enthält dieses Beispiel Zeilenumbrüche:
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
Alle Mitglieder werden in alphabetischer Reihenfolge der E-Mail-Adressen zurückgegeben. Verwenden Sie den pageToken-Suchstring für Antworten mit einer großen Anzahl von Mitgliedern. Bei der Paginierung gibt die Antwort die Property nextPageToken zurück, die ein Token für die nächste Seite mit Antwortergebnissen enthält. In der nächsten Anfrage wird dieses Token als Wert für den pageToken-Suchstring verwendet.
JSON-Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die Liste der Mitgliederinformationen zurückgegeben. Die id ist die eindeutige Mitglieds-ID des Mitglieds. In dieser Antwort gibt es eine nextPageToken für die nachfolgende Liste der Gruppenmitglieder:
{
"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"
}
Mitgliedschaft in einer Gruppe löschen
Wenn Sie die Mitgliedschaft eines Mitglieds in einer Gruppe löschen möchten, verwenden Sie die folgende DELETE-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. groupKey ist die eindeutige id der Gruppe und memberKey ist die primäre E-Mail-Adresse des gelöschten Nutzers oder Gruppenmitglieds oder die eindeutige id des Nutzers. Informationen zu den Anfrage- und Antworteigenschaften finden Sie in der API-Referenz:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Mit dieser DELETE-Anfrage wird beispielsweise das Mitglied gelöscht, dessen groupKey „nnn“ und dessen memberKey die primäre E-Mail-Adresse des Nutzers, „liz@beispiel.de“, ist:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 zurückgegeben.
Wenn ein Mitglied gelöscht wird, hat das folgende Auswirkungen:
- Mitglieder, die Sie entfernen, erhalten keine E-Mails mehr, die an die Gruppe adressiert sind.
- Das Konto des Mitglieds wird dabei jedoch nicht gelöscht.
- Auch wenn Sie den Gruppeninhaber löschen, funktioniert eine Gruppe weiterhin. Als Administrator können Sie die Gruppe verwalten oder die Inhaberschaft auf ein anderes Gruppenmitglied übertragen.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-08-29 (UTC).
[null,null,["Zuletzt aktualisiert: 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"]]
