Извлекает разбитый на страницы список либо удаленных пользователей, либо всех пользователей в домене.
HTTP-запрос
GET https://admin.googleapis.com/admin/directory/v1/users
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
Параметры | |
---|---|
customFieldMask | Список имен схем, разделенных запятыми. Выбираются все поля из этих схем. Это должно быть установлено только в случае, если |
customer | Уникальный идентификатор учетной записи Google Workspace клиента. В случае многодоменной учетной записи, чтобы получить все группы для клиента, используйте это поле вместо |
domain | Доменное имя. Используйте это поле, чтобы получить группы только из одного домена. Чтобы вернуть все домены для учетной записи клиента, используйте параметр запроса |
event | Событие, на которое предназначена подписка (при подписке) |
maxResults | Максимальное количество возвращаемых результатов. |
orderBy | Свойство, используемое для сортировки результатов. |
pageToken | Токен для указания следующей страницы в списке |
projection | Какое подмножество полей выбрать для этого пользователя. |
query | Строка запроса для поиска пользовательских полей. Дополнительные сведения о построении пользовательских запросов см. в разделе Поиск пользователей . |
showDeleted | Если установлено значение |
sortOrder | Возвращать ли результаты в порядке возрастания или убывания, игнорируя регистр. |
viewType | Следует ли получить общедоступное представление пользователя только для администратора или для всего домена. Дополнительные сведения см. в разделе Получение пользователя без прав администратора . |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит данные со следующей структурой:
Представление JSON |
---|
{
"kind": string,
"trigger_event": string,
"etag": string,
"users": [
{
object ( |
Поля | |
---|---|
kind | Типа это ресурс. |
trigger_event | Событие, вызвавшее этот ответ (используется только в случае Push Response) |
etag | ETag ресурса. |
users[] | Список пользовательских объектов. |
nextPageToken | Токен, используемый для доступа к следующей странице этого результата. |
Области авторизации
Требуется одна из следующих областей действия 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 | Результаты включают только поля для пользователя, которые общедоступны для других пользователей в домене. |