Dodawanie członka do grupy
Aby dodać użytkownika do grupy, użyj poniższego żądania POST i uwzględnij autoryzację opisaną w artykule Autoryzowanie żądań. Członek grupy może być użytkownikiem lub inną grupą. groupKey to adres e-mail nowego członka grupy lub unikalny identyfikator id grupy. Właściwości żą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ąć do 10 minut, zanim członkowie grupy podrzędnej pojawią się jako członkowie grupy nadrzędnej. Dodatkowo interfejs API zwraca błąd dla cykli członkostwa w grupach. Jeśli na przykład grupa1 jest członkiem grupy2, to grupa2 nie może być członkiem grupy1.
Żądanie JSON
Poniższe żądanie JSON pokazuje przykładową treść żądania, która tworzy członka grupy. Adres e-mail członka grupy to liz@example.com, a jego rola w grupie to MEMBER. Żądanie POST używa NNNNN dla 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 umożliwia zmienianie ustawień wysyłania wiadomości do grupy, dodawanie i usuwanie członków, zmienianie ról członków, zmienianie ustawień grupy i usuwanie grupy.OWNERmusi 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ć te same zadania co rolę WŁAŚCICIEL oprócz nadania członkowi roli WŁAŚCICIELA oraz usunięcia grupy. Grupa może mieć kilku członków (WŁAŚCICIEL i MENEDŻER).MEMBER– ta rola umożliwia subskrybowanie grupy, wyświetlanie archiwum dyskusji i wyświetlanie listy członków grupy. Więcej informacji o rolach członków znajdziesz w Centrum pomocy dotyczącym administrowania.
Odpowiedź JSON
Pomyślna odpowiedź zwraca kod stanu HTTP 200 i informacje o członkostwie użytkownika. id to unikalny identyfikator członkostwa użytkownika:
{
"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– użytkownik jest inną grupą.MEMBER– użytkownik jest użytkownikiem
Aktualizowanie członkostwa w grupie
Aby zaktualizować członkostwo w grupie, użyj następującego żądania PUT i dołącz autoryzację opisaną w artykule Autoryzowanie żądań. Element groupKey to adres e-mail grupy lub jej unikalny id, a memberKey to podstawowy adres e-mail użytkownika albo grupy, alias adresu e-mail użytkownika lub jego unikalny id. Właściwości żą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 pokazuje przykładową treść żądania, które aktualizuje ustawienia członkostwa w grupie. Adres e-mail członka grupy to liz@example.com, a rola członka grupy w grupie została zmieniona z MEMBER na MANAGER. Argument groupKey żądania PUT w tym przykładzie to NNNNN. Więcej informacji o rolach CZŁONEK, WŁAŚCICIEL i MENEDŻER znajdziesz w Centrum pomocy dla administratorów:
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 użytkownika:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"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 Autoryzowanie żądań. Element groupKey to adres e-mail grupy lub jej unikalny id, a memberKey to podstawowy adres e-mail użytkownika albo grupy, alias adresu e-mail użytkownika lub jego unikalny id. Właściwości żą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łonkostwa użytkownika:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"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 Autoryzowanie żądań. groupKey to adres e-mail grupy lub jej unikalny identyfikator id. Opcjonalny ciąg zapytania roles to filtr, który umożliwia pobieranie członków grupy według roli, a powstałe kolekcje ról są wyświetlane w kolejności podanej w filtrze roles. Właściwości żądania i odpowiedzi znajdziesz w dokumentacji interfejsu API (w języku angielskim). Aby zwiększyć czytelność, w tym przykładzie użyto funkcji zwracania wiersza:
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
Wszystkie adresy zostaną zwrócone w kolejności alfabetycznej według ich adresów e-mail. W przypadku odpowiedzi z dużą liczbą członków używaj 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 następnym żądaniu użyj 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łonkostwa użytkownika. Istnieje atrybut nextPageToken dla listy członków grupy w tej odpowiedzi:
{
"kind": "directory#members",
"members": [
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
},
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "radhe@example.com",
"role": "MANAGER",
"type": "MEMBER"
}
],
"nextPageToken": "NNNNN"
}
Usuwanie członkostwa w grupie
Aby usunąć członkostwo członka grupy, użyj następującego żądania DELETE i dołącz autoryzację opisaną w artykule Autoryzowanie żą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 jego unikalny adres id. Właściwości żądania i odpowiedzi znajdziesz w dokumentacji interfejsu API.
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKeyNa przykład to żądanie
DELETE usuwa użytkownika, którego groupKey to nnn i który 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 konto użytkownika zostanie usunięte:
- Usunięci przez Ciebie 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 będzie nadal działać normalnie. Jako administrator możesz zarządzać grupą lub przypisywać własność innemu członkowi grupy