Method: users.list

Получает постраничный список удаленных пользователей или всех пользователей в домене.

HTTP-запрос

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

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

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

Параметры
customFieldMask

string

Список имен схем, разделенных запятыми. Все поля из этих схем извлекаются. Это значение следует устанавливать только в том случае, если projection=custom .

customer

string

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

domain

string

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

event

enum ( Event )

Событие, на которое предназначена подписка (при подписке)

maxResults

integer

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

orderBy

enum ( OrderBy )

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

pageToken

string

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

projection

enum ( Projection )

Какое подмножество полей получить для этого пользователя.

query

string

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

showDeleted

string

Если установлено значение true , извлекается список удаленных пользователей. (По умолчанию: false )

sortOrder

enum ( SortOrder )

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

viewType

enum ( ViewType )

Следует ли получать общедоступное представление пользователя только для администратора или для всего домена. Дополнительные сведения см. в разделе Получение пользователя без прав администратора .

Тело запроса

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

Тело ответа

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

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

string

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

trigger_event

string

Событие, вызвавшее этот ответ (используется только в случае Push Response)

etag

string

ETag ресурса.

users[]

object ( User )

Список пользовательских объектов.

nextPageToken

string

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

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

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/cloud-platform

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

Событие

Тип события подписки

Перечисления
ADD Созданное пользователем событие
DELETE Событие, удаленное пользователем
MAKE_ADMIN Событие изменения статуса администратора пользователя
UNDELETE Событие восстановления пользователя
UPDATE Событие, обновленное пользователем

Заказ по

Перечисления
EMAIL Основной адрес электронной почты пользователя.
FAMILY_NAME Фамилия пользователя.
GIVEN_NAME Имя пользователя.

Проекция

Перечисления
BASIC Не включайте никаких настраиваемых полей для пользователя.
CUSTOM Включите настраиваемые поля из схем, запрошенных в customFieldMask .
FULL Включите все поля, связанные с этим пользователем.

Сортировать

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

Тип просмотра

Перечисления
admin_view Результаты включают как поля, доступные только администратору, так и общедоступные для домена поля пользователя.
domain_public Результаты включают только поля для пользователя, которые публично видны другим пользователям в домене.