Следит за изменениями в списке пользователей.
HTTP-запрос
POST https://admin.googleapis.com/admin/directory/v1/users/watch
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
Параметры | |
---|---|
domain | Имя домена. Заполните это поле, чтобы получить пользователей только из этого домена. Вместо этого, чтобы вернуть всех пользователей в многодоменное поле клиента, заполните поле клиента." |
customer | Неизменяемый идентификатор учетной записи Google Workspace. В случае мультидоменности, чтобы получить всех пользователей для клиента, заполните это поле вместо домена. |
event | События, за которыми стоит следить. |
customFieldMask | Разделенный запятыми список имен схем. Выбираются все поля из этих схем. Это должно быть установлено только тогда, когда проекция = пользовательская. |
maxResults | Максимальное количество возвращаемых результатов. |
orderBy | Столбец для сортировки результатов |
pageToken | Токен для указания следующей страницы в списке |
projection | Какое подмножество полей выбрать для этого пользователя. |
query | Поиск строки запроса. Должен иметь форму " |
showDeleted | Если установлено значение true, извлекается список удаленных пользователей. (По умолчанию: ложь) |
sortOrder | Возвращать ли результаты в порядке возрастания или убывания. |
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
Дополнительные сведения см. в руководстве по авторизации .
Тип события
Тип события подписки
перечисления | |
---|---|
ADD | Событие, созданное пользователем |
DELETE | Событие, удаленное пользователем |
MAKE_ADMIN | Событие изменения статуса администратора пользователя |
UNDELETE | Восстановленное пользователем событие |
UPDATE | Событие, обновленное пользователем |
Сортировать по
перечисления | |
---|---|
EMAIL | Основной адрес электронной почты пользователя. |
FAMILY_NAME | Фамилия пользователя. |
GIVEN_NAME | Имя пользователя. |
Проекция
перечисления | |
---|---|
BASIC | Не включайте никаких настраиваемых полей для пользователя. |
CUSTOM | Включите настраиваемые поля из схем, упомянутых в customFieldMask. |
FULL | Включить все поля, связанные с этим пользователем. |
Порядок сортировки
перечисления | |
---|---|
ASCENDING | Восходящий порядок. |
DESCENDING | В порядке убывания. |
Тип просмотра
перечисления | |
---|---|
admin_view | Результаты включают как поля только для администратора, так и общедоступные поля домена. |
domain_public | Результаты включают только поля для пользователя, которые общедоступны для других пользователей в домене. |