Directory API: członkowie grupy

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.