Предоставляет список профилей домена и контактов домена в каталоге домена пользователя, прошедшего проверку подлинности.
Если
, ресурсы, удаленные с момента последней синхронизации, будут возвращены как человек с syncToken
, для которого задано значение true.PersonMetadata.deleted
Когда
или pageToken
, все остальные параметры запроса должны соответствовать первому вызову.syncToken
Запись может иметь задержку распространения в несколько минут для запросов синхронизации. Добавочная синхронизация не предназначена для случаев чтения после записи.
См. пример использования в списке людей из каталога, которые изменились .
HTTP-запрос
GET https://people.googleapis.com/v1/people:listDirectoryPeople
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
Параметры | |
---|---|
readMask | Необходимый. Маска поля для ограничения возвращаемых полей для каждого человека. Можно указать несколько полей, разделив их запятыми. Допустимые значения:
|
sources[] | Необходимый. Источники каталога для возврата. |
mergeSources[] | По желанию. Дополнительные данные для объединения с источниками каталогов, если они подключены через проверенные ключи присоединения, такие как адреса электронной почты или номера телефонов. |
pageSize | По желанию. Количество людей, которых следует включить в ответ. Допустимые значения находятся в диапазоне от 1 до 1000 включительно. По умолчанию 100, если не установлено или установлено на 0. |
pageToken | По желанию. Токен страницы, полученный из предыдущего ответа При разбиении на страницы все остальные параметры, предоставленные для |
requestSyncToken | По желанию. Должен ли ответ возвращать Дополнительные сведения о поведении синхронизации см. в |
syncToken | По желанию. Маркер синхронизации, полученный из предыдущего ответа При синхронизации все остальные параметры, предоставленные для Дополнительные сведения о поведении синхронизации см. в |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит данные со следующей структурой:
Ответ на запрос каталога домена аутентифицированного пользователя.
Представление JSON |
---|
{
"people": [
{
object ( |
Поля | |
---|---|
people[] | Список людей в каталоге домена. |
nextPageToken | Маркер, который можно отправить как |
nextSyncToken | Маркер, который можно отправить как |
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/directory.readonly
Дополнительные сведения см. в руководстве по авторизации .