Method: groups.list

Извлекает все группы домена или пользователя с заданным userKey (с разбивкой на страницы).

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры запроса

Параметры
customer

string

Уникальный идентификатор аккаунта Google Workspace клиента. В случае многодоменной учетной записи, чтобы получить все группы для клиента, используйте это поле вместо domain . Вы также можете использовать псевдоним my_customer для представления customerId вашей учетной записи. customerId также возвращается как часть ресурса Users . Необходимо указать параметр customer или domain .

domain

string

Доменное имя. Используйте это поле, чтобы получить группы только из одного домена. Чтобы вернуть все домены для учетной записи клиента, используйте вместо этого параметр запроса customer .

maxResults

integer

Максимальное количество возвращаемых результатов. Максимально допустимое значение — 200.

orderBy

enum ( OrderBy )

Столбец, используемый для сортировки результатов

pageToken

string

Токен для указания следующей страницы в списке

query

string

Поиск строки запроса. Должно быть вида " Полная документация находится по адресу https://developers.google.com/workspace/admin/directory/v1/guides/search-groups.

sortOrder

enum ( SortOrder )

Возвращать ли результаты в порядке возрастания или убывания. Используется только тогда, когда также используется orderBy.

userKey

string

Адрес электронной почты или неизменяемый идентификатор пользователя, если необходимо указать только те группы, членом которых является данный пользователь. Если это идентификатор, он должен совпадать с идентификатором пользовательского объекта. Невозможно использовать с параметром customer .

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "kind": string,
  "etag": string,
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
Поля
kind

string

Это такой ресурс.

etag

string

ETag ресурса.

groups[]

object ( Group )

Список групповых объектов.

nextPageToken

string

Токен, используемый для доступа к следующей странице этого результата.

Области авторизации

Требуется одна из следующих областей 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

Дополнительную информацию см. в руководстве по авторизации .

Заказ по

Перечисления
EMAIL Электронная почта группы.

Сортировать

Перечисления
ASCENDING Восходящий порядок.
DESCENDING Нисходящий порядок.