Directory API: członkowie grupy

Dodawanie użytkownika do grupy

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

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

Jeśli dodasz grupę jako członka innej grupy, może minąć do 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 w członkostwie w grupach. Jeśli np. grupa1 jest członkiem grupy2, grupa2 nie może być członkiem grupy1.

Żądanie JSON

Poniższe żądanie JSON przedstawia przykładową treść żądania, która tworzy członka grupy. Adres e-mail członka to liz@example.com, a jego rola w grupie to MEMBER. Żądanie POST używa wartości NNNNN w przypadku parametru groupKey: 

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 może zmieniać ustawienia wysyłania wiadomości do grupy, dodawać i usuwać członków, zmieniać role członków, 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łączona w konsoli administracyjnej Google. Użytkownik z rolą MENEDŻER może wykonywać te same czynności co użytkownik z rolą WŁAŚCICIEL, z wyjątkiem przyznawania członkom roli WŁAŚCICIEL i usuwania grupy. Grupa może mieć wielu właścicieli i menedżerów.
  • MEMBER – ta rola umożliwia subskrybowanie grupy, wyświetlanie archiwów dyskusji i 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 uczestnika programu: 

{
   "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 – członkiem jest 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 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 jego unikalny id. Informacje o właściwościach żą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ładową treść żądania, która aktualizuje ustawienia członkostwa w grupie. Adres e-mail członka 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 administratora: 

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 uczestnika programu: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

Pobieranie członka grupy

Aby pobrać informacje o członkostwie w grupie, użyj poniższego żą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 jego unikalny id. Informacje o właściwościach żą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 użytkownika. id to unikalny identyfikator uczestnika programu: 

{
   "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 id. Opcjonalny ciąg zapytania roles to filtr, który umożliwia pobieranie członków grupy według roli, a wynikowe kolekcje ról są uporządkowane zgodnie z kolejnością podaną w filtrze roles. Informacje o właściwościach żądań i odpowiedzi znajdziesz w dokumentacji API. Aby ułatwić czytanie, w tym przykładzie użyto znaków ł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 członkowie są zwracani w porządku alfabetycznym według adresów e-mail. 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 następnej strony wyników odpowiedzi. W kolejnym żądaniu użyjesz 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 odpowiedzi znajduje się nextPageToken z dalszą listą 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 użytkownika w grupie, użyj poniższego żądania DELETE i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. groupKey to unikalny id grupy, a memberKey to podstawowy adres e-mail usuniętego użytkownika lub członka grupy albo unikalny id użytkownika. Informacje o właściwościach żą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 członka, którego groupKey to nnn, a memberKey to podstawowy adres e-mail użytkownika, ela@example.com: 
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com

Prawidłowa odpowiedź zwraca kod stanu HTTP 200.

Gdy członek 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 konta użytkownika.
  • Jeśli usuniesz właściciela grupy, grupa nadal będzie działać normalnie. Jako administrator możesz zarządzać grupą lub mianować innych członków grupy jej właścicielami.