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

Поиск по строке запроса. Содержит одно или несколько условий поиска, каждое из которых содержит поле, оператор и значение. Полную документацию см. в разделе Поиск групп .

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 В порядке убывания.