Method: groups.list

Pobiera wszystkie grupy domeny lub użytkownika o podanym kluczu userKey (z podziałem na strony).

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
customer

string

Unikalny identyfikator konta Google Workspace klienta. W przypadku konta z wieloma domenami, aby pobrać wszystkie grupy klienta, użyj tego pola zamiast domain. Możesz też użyć aliasu my_customer do reprezentowania identyfikatora customerId swojego konta. Element customerId jest też zwracany jako część zasobu Users. Musisz podać parametr customer lub domain.
domain

string

Nazwa domeny. Użyj tego pola, aby pobrać grupy tylko z jednej domeny. Aby zwrócić wszystkie domeny dla konta klienta, użyj parametru zapytania customer.
maxResults

integer

Maksymalna liczba wyników do zwrócenia. Maksymalna dozwolona wartość to 200.
orderBy

enum (OrderBy)

Kolumna do sortowania wyników
pageToken

string

Token do określenia następnej strony na liście
query

string

Wyszukiwanie ciągu zapytania. Powinien mieć postać „”. Pełną dokumentację można znaleźć pod adresem https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups.
sortOrder

enum (SortOrder)

Określa, czy wyniki mają być zwracane w kolejności rosnącej czy malejącej. Używane tylko w przypadku użycia atrybutu orderBy
userKey

string

Adres e-mail lub stały identyfikator użytkownika, jeśli ma być wymieniony tylko dany użytkownik, do którego należy dany użytkownik. Jeśli jest to identyfikator, powinien być zgodny z identyfikatorem obiektu użytkownika.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "kind": string,
  "etag": string,
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
Pola
kind

string

To pewnego rodzaju zasób.
etag

string

ETag zasobu.
groups[]

object (Group)

Lista obiektów grupy.
nextPageToken

string

Token używany do uzyskania dostępu do następnej strony tego wyniku.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.readonly

Więcej informacji znajdziesz w przewodniku po autoryzacji.

OrderBy

Wartości w polu enum
EMAIL Adres e-mail grupy.

SortOrder

Wartości w polu enum
ASCENDING Porządek rosnący.
DESCENDING Malejąco.