Directory API: członkowie grupy
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Dodawanie użytkownika do grupy
Aby dodać członka do grupy, użyj tego żądania POST i dołącz autoryzację opisaną w artykule Autoryzowanie żądań. Członkiem grupy może być użytkownik lub inna grupa. groupKey to adres e-mail grupy nowego członka lub unikalny id grupy. Właściwości żądań i odpowiedzi znajdziesz w dokumentacji API:
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
Jeśli dodasz grupę jako element innej grupy, może minąć do 10 minut, zanim członkowie grupy podrzędnej pojawią się jako członkowie grupy nadrzędnej. Ponadto interfejs API zwraca błąd w przypadku cykli w przypadku członkostwa w grupach. Jeśli na przykład grupa1 jest członkiem grupy2, grupa2 nie może być członkiem grupy1.
Żądanie JSON
Poniższe żądanie w formacie JSON zawiera przykładowy tekst żądania, który tworzy członka grupy. Adres e-mail tego użytkownika to liz@example.com, a jego rola w grupie to MEMBER. W prośbie POST w kolumnie groupKey występuje wartość NNNNN:
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members
{
"email": "liz@example.com",
"role": "MEMBER"
}
role członka grupy może być:
OWNER – ta rola pozwala wysyłać wiadomości do grupy, dodawać i usuwać członków, zmieniać ich role, zmieniać ustawienia grupy i usuwać grupę. OWNER musi być członkiem grupy.
MANAGER – ta rola jest dostępna tylko wtedy, gdy Google Workspace jest włączone w konsoli administracyjnej. Użytkownik z rolą menedżera może wykonywać wszystkie czynności, które może wykonać użytkownik z rolą właściciela, z wyjątkiem nadawania innym użytkownikom roli właściciela i usuwania grupy. Grupa może mieć wielu właścicieli i menedżerów.
MEMBER – ta rola pozwala subskrybować grupę, przeglądać archiwa dyskusji i wyświetlać listę członków grupy. Więcej informacji o rolach członków znajdziesz w Centrum pomocy administracyjnej.
Odpowiedź JSON
Pomyślna odpowiedź zwraca kod stanu HTTP 200 i informacje o członkostwie. id to unikalny identyfikator członkostwa:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MEMBER",
"type": "GROUP"
}
type członka grupy może być:
GROUP – element jest inną grupą.MEMBER – członek jest użytkownikiem
Zmiana członkostwa w grupie
Aby zaktualizować członkostwo w grupie, użyj podanego poniżej żądania PUT i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. groupKey to adres e-mail grupy lub jej unikalny id, a memberKey to podstawowy adres e-mail użytkownika lub grupy, alias adresu e-mail użytkownika lub unikalny id użytkownika. Właściwości żądań i odpowiedzi znajdziesz w dokumentacji API:
PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Żądanie JSON
Poniższe żądanie JSON zawiera przykładowy tekst żądania, który aktualizuje ustawienia członkostwa w grupie. Adres e-mail tego użytkownika to liz@example.com, a jego rola w grupie została zmieniona z MEMBER na MANAGER. W tym przykładzie groupKey żądania PUT to NNNNN. Informacje o rolach CZŁONEK, WŁAŚCICIEL i MENEDŻER znajdziesz w Centrum pomocy administracji:
PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
{
"email": "liz@example.com",
"role": "MANAGER"
}
Odpowiedź JSON
Pomyślna odpowiedź zwraca kod stanu HTTP 200 i zaktualizowane informacje o członkostwie. id to unikalny identyfikator członkostwa:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
Pobieranie informacji o członku grupy
Aby pobrać informacje o członkostwie w grupie, użyj żądania GET i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. groupKey to adres e-mail grupy lub jej unikalny id, a memberKey to podstawowy adres e-mail użytkownika lub grupy, alias adresu e-mail użytkownika lub unikalny id użytkownika. Właściwości żądań i odpowiedzi znajdziesz w dokumentacji API:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Odpowiedź JSON
Pomyślna odpowiedź zwraca kod stanu HTTP 200 i informacje o członkostwie. id to unikalny identyfikator członkostwa:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
Pobieranie wszystkich członków grupy
Aby pobrać wszystkich członków grupy, użyj poniższego żądania GET i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. groupKey to adres e-mail grupy lub jej unikalny identyfikator id. Opcjonalny ciąg znaków zapytania roles to filtr, który umożliwia pobieranie członków grupy według roli. Wyniki zbiorów ról są podawane w kolejności podanej w filtrze roles. Właściwości żądań i odpowiedzi znajdziesz w dokumentacji API. Aby ułatwić czytanie, przykład zawiera łamania wierszy:
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
Wszyscy użytkownicy są zwracani w porządku alfabetycznym według ich adresów e-mail. A w przypadku odpowiedzi z dużą liczbą członków użyj ciągu zapytania pageToken. W przypadku podziału na strony odpowiedź zwraca właściwość nextPageToken, która zawiera token do następnej strony wyników odpowiedzi. Kolejne żądanie używa tego tokena jako wartości ciągu zapytania pageToken.
Odpowiedź JSON
Pomyślna odpowiedź zwraca kod stanu HTTP 200 i listę informacji o członkach. id to unikalny identyfikator członkostwa. W tej odpowiedzi jest nextPageToken na liście dalszych działań dla członków grupy:
{
"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"
}
Usuwanie członkostwa w grupie
Aby usunąć członkostwo w grupie, użyj żądania DELETE i dołącz autoryzację opisaną w Autoryzowanie żądań. groupKey to unikalny id grupy, a memberKey to główny adres e-mail usuniętego użytkownika lub członka grupy albo unikalny id użytkownika. Właściwości żądań i odpowiedzi znajdziesz w dokumentacji API:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Na przykład to żądanie DELETE usuwa element, którego groupKey to nnn, a memberKey to podstawowy adres e-mail użytkownika, liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com
Pomyślna odpowiedź zwraca kod stanu HTTP 200.
Gdy członek grupy zostanie usunięty:
- Usunięci członkowie nie będą już otrzymywać e-maili adresowanych do grupy.
- Usunięcie członka z grupy nie powoduje usunięcia jego konta.
- Jeśli usuniesz właściciela grupy, grupa nadal będzie działać normalnie. Jako administrator możesz zarządzać grupą lub mianować innych użytkowników jej właścicielami.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-08-29 UTC.
[null,null,["Ostatnia aktualizacja: 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"]]
