Directory API: członkowie grupy

Dodawanie członka do grupy

Aby dodać użytkownika do grupy, użyj poniższego żądania POST i dołącz autoryzację opisaną w artykule Autoryzacja żądań. Członkiem grupy może być użytkownik lub inna grupa. groupKey to adres e-mail grupy nowego członka lub unikalny adres id grupy. Informacje o właściwościach żądania i odpowiedzi znajdziesz w dokumentacji interfejsu API: 

POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members

Jeśli dodasz grupę jako członka innej grupy, może minąć nawet 10 minut, zanim członkowie grupy podrzędnej pojawią się jako członkowie grupy nadrzędnej. Dodatkowo interfejs API zwraca błąd w przypadku cykli członkostwa w grupach. Jeśli na przykład grupa 1 jest członkiem grupy 2, grupa 2 nie może być członkiem grupy 1.

Żądanie JSON

Podane niżej żądanie JSON wyświetla przykładową treść żądania, która tworzy członka grupy. Adres e-mail użytkownika to [email protected], a rola członka grupy to MEMBER. Żądanie POST używa NNNNN na potrzeby elementu groupKey: 

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members

{
   "email": "[email protected]",
    "role": "MEMBER"
}

Uprawnienia role członka grupy mogą być:

  • OWNER – ta rola umożliwia wysyłanie wiadomości do grupy, dodawanie i usuwanie członków, zmienianie ról członków, zmienianie ustawień grupy i usuwanie grupy. Element OWNER musi być członkiem grupy.
  • MANAGER – ta rola jest dostępna tylko wtedy, gdy usługa Google Workspace jest włączona w konsoli administracyjnej. Rola MENEDŻER może wykonywać wszystkie czynności, które ma użytkownik WŁAŚCICIEL, z wyjątkiem ustawiania członka jako WŁAŚCICIELA i usuwania grupy. Grupa może mieć wielu członków – WŁAŚCICIEL i MENEDŻER.
  • MEMBER – ta rola umożliwia subskrybowanie grupy, wyświetlanie archiwów dyskusji i wyświetlanie listy członków grupy. Więcej informacji o rolach członków znajdziesz w Centrum pomocy dla administratorów.

Odpowiedź JSON

Pomyślna odpowiedź zwraca kod stanu HTTP 200 i informacje o członkostwie użytkownika. id to unikalny identyfikator członka grupy: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "[email protected]",
   "role": "MEMBER",
   "type": "GROUP"
  }

Uprawnienia type członka grupy mogą być:

  • GROUP – członek to inna grupa.
  • MEMBER – członek jest użytkownikiem.

Aktualizowanie członkostwa w grupie

Aby zaktualizować członkostwo w grupie, użyj poniższego żądania PUT i dołącz autoryzację opisaną w artykule Autoryzacja żądań. groupKey to adres e-mail grupy lub unikalny identyfikator id grupy, a memberKey to podstawowy adres e-mail użytkownika lub grupy, alias adresu e-mail użytkownika lub unikalny identyfikator id użytkownika. Informacje o właściwościach żądania i odpowiedzi znajdziesz w dokumentacji interfejsu API: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey

Żądanie JSON

Poniższe żądanie JSON zawiera przykładową treść żądania, która aktualizuje ustawienia członkostwa w grupie. Adres e-mail członka to [email protected], a rola członka grupy została zmieniona z MEMBER na MANAGER. W tym przykładzie groupKey żądania PUT to NNNNN. Więcej informacji o rolach CZŁONEK, WŁAŚCICIEL i MENEDŻER I MENEDŻER znajdziesz w Centrum pomocy dla administratorów: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/[email protected]
 
{
   "email": "[email protected]",
    "role": "MANAGER"
}

Odpowiedź JSON

Pomyślna odpowiedź zwraca kod stanu HTTP 200 i zaktualizowane informacje o członkostwie. id to unikalny identyfikator członka grupy: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "[email protected]",
   "role": "MANAGER",
   "type": "GROUP"
  }

Pobieranie członka grupy

Aby pobrać członkostwo w grupie, użyj poniższego żądania GET i dołącz autoryzację opisaną w artykule Autoryzacja żądań. groupKey to adres e-mail grupy lub unikalny identyfikator id grupy, a memberKey to podstawowy adres e-mail użytkownika lub grupy, alias adresu e-mail użytkownika lub unikalny identyfikator id użytkownika. Informacje o właściwościach żądania i odpowiedzi znajdziesz w dokumentacji interfejsu 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 użytkownika. id to unikalny identyfikator członka grupy: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "[email protected]",
   "role": "MANAGER",
   "type": "GROUP"
  }

Pobierz wszystkich członków grupy

Aby pobrać wszystkich członków grupy, użyj poniższego żądania GET i dołącz autoryzację opisaną w artykule Autoryzacja żądań. groupKey to adres e-mail grupy lub jej unikalny identyfikator id. Opcjonalny ciąg zapytania roles to filtr umożliwiający pobieranie członków grupy według roli. Wynikowe zbiory ról są ułożone w kolejności określonej w filtrze roles. Informacje o właściwościach żądań i odpowiedzi znajdziesz w dokumentacji interfejsu API. Aby zwiększyć czytelność, ten przykład zwraca wiersze: 

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 członkowie są zwracani w porządku alfabetycznym na liście członków adresy e-mail. W przypadku odpowiedzi z dużą liczbą członków użyj też ciągu zapytania pageToken. W przypadku podziału na strony odpowiedź zwraca właściwość nextPageToken, która zawiera token następnej strony wyników. Twoje następne żą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 użytkowniku. id to unikalny identyfikator członka grupy. W tej odpowiedzi znajduje się nextPageToken na liście dalszych członków grupy: 

{
   "kind": "directory#members",
   "members": [
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "[email protected]",
    "role": "MANAGER",
    "type": "USER"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "[email protected]",
    "role": "MANAGER",
    "type": "USER"
   }
  ],
   "nextPageToken": "NNNNN"
}

Usuwanie członkostwa w grupie

Aby usunąć członkostwo użytkownika w grupie, użyj żądania DELETE i dołącz autoryzację opisaną w artykule Autoryzacja żądań. groupKey to unikalny adres e-mail id grupy, a memberKey to podstawowy adres e-mail usuniętego użytkownika lub członka grupy albo niepowtarzalny adres id użytkownika. Informacje o właściwościach żądania i odpowiedzi znajdziesz w dokumentacji interfejsu API: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
 Na przykład to żądanie DELETE powoduje usunięcie użytkownika, którego groupKey to nnn, a memberKey jest jego podstawowym adresem e-mail ([email protected]): 
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/[email protected]

Pomyślna odpowiedź zwraca kod stanu HTTP 200.

Gdy użytkownik zostanie usunięty:

  • Usunięci członkowie nie będą otrzymywać e-maili adresowanych do grupy.
  • Usunięcie członka z grupy nie powoduje usunięcia konta użytkownika.
  • Jeśli usuniesz właściciela grupy, grupa będzie nadal działać normalnie. Jako administrator możesz zarządzać grupą lub przypisać własność innemu członkowi grupy