Zarządzaj grupami

Tworzenie grupy

Aby utworzyć grupę, użyj żądania POST i dołącz autoryzację opisane w Autoryzacja żądań. Możesz utworzyć grupę dla każdej domeny powiązanej z kontem. W przypadku ciągów zapytania żądanie i właściwości odpowiedzi, zapoznaj się z Metoda groups.insert.

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

Podane niżej żądanie JSON wyświetla przykładową treść żądania, która tworzy grupę. Adres e-mail grupy adres to sprzedaz_grupa@example.com:

{
   "email": "sales_group@example.com",
   "name": "Sales Group",
   "description": "This is the Sales group."
}

Poprawna odpowiedź zwraca błąd Kod stanu HTTP 201 i właściwościach nowej grupy.

Aktualizowanie grupy

Aby zaktualizować ustawienia grupy, użyj żądania PUT i dołącz autoryzacja opisana w Autoryzacja żądań. groupKey to adres e-mail grupy, dowolny adres e-mail aliasu grupy, lub unikalny identyfikator id grupy. W przypadku ciągów zapytań, właściwości żądania i odpowiedzi zobacz Metoda groups.update.

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

Ogólnie Google nie zaleca używania adresu e-mail grupy jako klucza dla trwałych danych. ponieważ adres e-mail może ulec zmianie.

W poniższym przykładzie unikalnym groupKey jest nnn, a grupa Nazwa firmy to APAC Sales Group:

PUT https://admin.googleapis.com/admin/directory/v1/groups/nnn

{
    "email": "sales_group@example.com",
    "name": "APAC Sales Group"
}

W przypadku prośby o aktualizację musisz przesłać w prośbie tylko zaktualizowane informacje. Ty nie wszystkie właściwości grupy w żądaniu.

Poprawna odpowiedź zwraca błąd Kod stanu HTTP 201 oraz właściwości nowej grupy:

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "liz@test.com"
     }
    ]
}

Dodaj alias grupy

Aby dodać alias grupy, użyj poniższego żądania POST i dołącz autoryzację opisane w artykule Autoryzacja żądań. groupKey to adres e-mail grupy i dowolny alias grupy adresu e-mail lub unikalny identyfikator id grupy. Informacje o ciągach zapytań oraz właściwościach żądań i odpowiedzi znajdziesz tutaj zasób groups.

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

Ogólnie Google nie zaleca używania adresu e-mail grupy jako klucza dla trwałych danych. ponieważ adres e-mail może ulec zmianie.

Poniżej znajduje się żądanie JSON z przykładowym żądaniem utworzenia aliasu grupy. groupKey to unikalna wartość id grupy reprezentowana przez NNNN

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNN/aliases

{
    "alias": "best_sales_group@example.com"
}

Poprawna odpowiedź zwraca błąd Kod stanu HTTP 201 oraz właściwości nowego aliasu grupy.

Pobieranie grupy

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey

Ogólnie Google nie zaleca używania adresu e-mail grupy jako klucza dla trwałych danych. ponieważ adres e-mail może ulec zmianie.

W tym przykładzie unikalny identyfikator groupKey to nnnn:

GET https://admin.googleapis.com/admin/directory/v1/groups/nnnn

Poprawna odpowiedź zwraca błąd Kod stanu HTTP 200 a ustawienia grupy:

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "liz@test.com"
     }
    ]
}

Pobierz wszystkie grupy z domeny lub konta

Aby pobrać wszystkie grupy dla określonej domeny lub konta, użyj następującego polecenia GET i dołącz upoważnienie opisane w Autoryzacja żądań. W przypadku zapytania ciągów tekstowych, żądań i odpowiedzi, zapoznaj się z Metoda groups.list. Aby zwiększyć czytelność, ten przykład zwraca wiersze:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=domain name
&customer=my_customer or customerId&pageToken=pagination token
&maxResults=max results

Podczas pobierania wszystkich grup z domeny lub konta weź pod uwagę następujące kwestie:

• Wszystkie grupy w subdomenie: użyj argumentu domain z nazwą domeny.
• Wszystkie grupy na koncie: użyj argumentu customer z jedną z tych opcji my_customer lub customerId konta. Jako konto administratora, użyj ciągu my_customer do reprezentowania adresu customerId Jeśli jesteś sprzedawcą, który ma dostęp do konta klienta sprzedawcy, użyj customerId konta sprzedawcy. W przypadku wartości customerId użyj jako nazwę domeny podstawowej konta Pobierz wszystkich użytkowników z domeny żądania operacji. Otrzymana odpowiedź ma wartość customerId.
• Przy użyciu argumentów domain i customer: Interfejs Directory API zwraca wszystkie grupy w elemencie domain.
• Bez argumentów domain i customer: Interfejs Directory API zwraca wszystkie grupy na koncie powiązanym z my_customer Jest to konto customerId administratora, które utworzył do ich przesłania.
• Przy użyciu argumentów customer i userKey: Interfejs Directory API zwraca błąd. Musisz przesłać 2 osobne żądania z tymi .

W poniższym przykładzie administrator konta używa polecenia my_customer, aby poprosić o listę wszystkich: grup konta:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=my_customer&maxResults=2

W poniższym przykładzie żądanie administratora sprzedawcy zwraca wszystkie grupy na sprzedanym koncie dzięki funkcji customerId C03az79cb. Maksymalna liczba wyników zwracanych na stronę odpowiedzi to 2. W tej odpowiedzi znajduje się nextPageToken dla listy użytkowników, którzy mogą być na bieżąco.

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=C03az79cb&maxResults=2

Poprawna odpowiedź zwraca błąd Kod stanu HTTP 200 oraz grupy w porządku alfabetycznym na liście adresów e-mail:

{
"kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support@sales.com",
      "name": "Sales support",
      "directMembersCount": "6",
      "description": "The sales support group",
      "adminCreated": true
     },
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "travel@sales.com",
      "name": "Sales travel",
      "directMembersCount": "2",
      "description": "The travel group supporting sales",
      "adminCreated": false,
      "aliases": [
       {
         "alias": "best_sales_group@example.com"
       }
      ],
      "nonEditableAliases: [
       {
         "alias": "liz@test.com"
       }
      ]
     },
  "nextPageToken": "NNNN"
  }

Pobierz wszystkie grupy dla członka

Aby pobrać wszystkie grupy, których użytkownik ma subskrypcję, użyj następującego polecenia GET i dołącz upoważnienie opisane w Autoryzacja żądań. Aby zapewnić czytelność, w tym przykładzie użyto zwracania wierszy:

GET https://admin.googleapis.com/admin/directory/v1/groups?userKey=user key
?pageToken=pagination token
&maxResults=maximum results per response page

• Członkiem może być użytkownik lub grupa.
• userKey może być podstawowym adresem e-mail użytkownika, aliasem adresu e-mail użytkownika podstawowy adres e-mail grupy, alias e-mail grupy lub unikalny adres e-mail użytkownika (id) które można znaleźć za pomocą Pobieranie operacji użytkownika
• Użytkownik lub grupa określona w userKey musi należeć do Twojej domeny.
• W przypadku odpowiedzi obejmujących dużą liczbę grup użyj ciągu zapytania pageToken. W w przypadku podziału na strony, odpowiedź zwraca właściwość nextPageToken, która daje token dla następnej strony z wynikami odpowiedzi. Twoje następne żądanie używa tego tokena jako Wartość ciągu zapytania pageToken.
• Przy użyciu argumentów customer i userKey: Interfejs Directory API zwraca błąd. Musisz przesłać 2 osobne żądania z tymi .

Właściwości żądania i odpowiedzi znajdziesz w Metoda groups.list.

Poprawna odpowiedź zwraca błąd Kod stanu HTTP 200 oraz lista informacji o członkostwie:

• Wszystkie grupy, których użytkownik ma subskrypcję, w tym grupy spoza domeny użytkownika domeny,
• Grupy są zwracane w kolejności alfabetycznej według adresów e-mail poszczególnych grup.
• W treści odpowiedzi id to unikalny identyfikator grupy.
• W odpowiedzi lista grupy spoza domeny użytkownika nie będzie zawierać instrukcji poza aliasami grupy.

{
    "kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "sales_group@example.com",
      "name": "sale group",
      "directMembersCount": "5",
      "description": "Sales group"
     },
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support_group.com",
      "name": "support group",
      "directMembersCount": "5",
      "description": "Support group"
     }
  ],
   "nextPakeToken": "NNNNN"
}

Pobierz wszystkie aliasy grup

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases

Poprawna odpowiedź zwraca błąd Kod stanu HTTP 201 i listę aliasów grupy.

Usuwanie aliasu grupy

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases/aliasId

Poprawna odpowiedź zwraca błąd Kod stanu HTTP 201.

Usuwanie grupy

Aby usunąć grupę, użyj poniższego żądania DELETE i dołącz autoryzację opisane w Autoryzacja żądań. groupKey to unikalny identyfikator id grupy:

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey

DELETE https://admin.googleapis.com/admin/directory/v1/group/nnnn

Poprawna odpowiedź zwraca błąd Kod stanu HTTP 200.

Po usunięciu grupy:

• Wszyscy członkowie grupy zostaną usunięci. Konta użytkowników nie zostaną usunięte.
• Archiwum grupy zostanie usunięte.
• Wiadomości wysyłane na adres usuniętej grupy nie są dostarczane. Zamiast tego nadawca otrzymuje o problemie z dostarczeniem.