Method: users.watch

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

HTTP-запрос

POST https://admin.googleapis.com/admin/directory/v1/users/watch

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

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

Параметры
domain

string

Имя домена. Заполните это поле, чтобы получить пользователей только из этого домена. Чтобы получить всех пользователей из нескольких доменов, заполните поле "Клиент".

customer

string

Неизменяемый идентификатор учётной записи Google Workspace. В случае использования нескольких доменов, чтобы получить всех пользователей клиента, заполните это поле вместо домена.

event

enum ( EventType )

События, за которыми стоит следить.

customFieldMask

string

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

maxResults

integer

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

orderBy

enum ( OrderBy )

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

pageToken

string

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

projection

enum ( Projection )

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

query

string

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

showDeleted

string

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

sortOrder

enum ( SortOrder )

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

viewType

enum ( ViewType )

Необходимо ли получить общедоступное представление пользователя, доступное только администратору или всему домену. Подробнее см. в разделе «Извлечение пользователя как неадминистратора» .

Текст запроса

Тело запроса содержит экземпляр SubscriptionChannel .

Тело ответа

В случае успеха тело ответа содержит экземпляр SubscriptionChannel .

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

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

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

EventType

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

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

Сортировать по

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

Проекция

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

СортировкаПорядок

Перечисления
ASCENDING По возрастанию.
DESCENDING В порядке убывания.

ViewType

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