Список людей

Пространство имен: microsoft.graph

Получите коллекцию объектов person, упорядоченных по их релевантности для пользователя, которая определяется его моделями общения и совместной работы, а также бизнес-отношениями.

Вы можете получить эту информацию через API People. Например, см. раздел "Примеры" и статью Используйте API People, чтобы получать сведения о наиболее важных для вас людях.

Примечание.

Для новых разработок мы рекомендуем использовать API Поиска (Майкрософт) (POST /search/query with entityTypes: ["person"]) вместо API People (GET /me/people and GET /users/{id | userPrincipalName}/people). API People находится в режиме обслуживания. Дополнительные сведения см. в разделах searchEntity: query и Использование API поиска (Майкрософт) для поиска людей.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальное обслуживание Правительство США L4 Правительство США L5 (DOD) Китай, обслуживаемый 21Vianet
✅ ✅ ✅ ❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более высокий уровень привилегий или разрешений, только если это требуется вашему приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в статье Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшим объемом привилегий Разрешения с более высоким уровнем привилегий
Делегированные (рабочая или учебная учетная запись) People.Read People.Read.All
Делегированные (личная учетная запись Майкрософт) People.Read Недоступно.
Для приложений People.Read.All Недоступно.

HTTP-запрос

GET /me/people
GET /users/{id | userPrincipalName}/people

Необязательные параметры запросов

Этот метод поддерживает параметры запросов OData для настройки отклика.

Имя Значение Описание
$filter string Позволяет возвращать в отклике только тех людей, чьи записи содержат указанные критерии.
$orderby строка По умолчанию люди в ответе сортируются по степени соответствия запросу. Этот порядок можно изменить с помощью параметра $orderby.
$search string Поиск пользователей по имени или псевдониму. Поддерживается нечеткое соответствие. Параметр применяется только для поиска людей, относящихся к вошедшему пользователю, а не для поиска людей, относящихся к другим пользователям. Также поддерживает ключевое слово topic для поиска людей с учетом тем, извлеченных из бесед электронной почты с определенным человеком. Сведения и примеры см. в разделе "Выполнение нечеткого поиска" на странице Использование API People для получения сведений о наиболее важных для вас людях.
$select string Разделенный запятыми список свойств, включаемых в ответ. Для оптимальной производительности выбирайте только подмножество необходимых свойств.
$skip int Пропустите первые n результатов, что полезно для разбиения на страницы. При использовании $search это не поддерживается.
$top int Максимальное количество результатов, возвращаемых на странице результатов. Дополнительные сведения см. в верхнем параметре.

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения об аутентификации и авторизации.
Accept application/json

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

Не указывайте текст запроса для этого метода.

Отклик

В случае успеха этот метод возвращает код ответа 200 OK и коллекцию объектов пользователя в тексте ответа. Отклик может содержать один объект пользователя или набор объектов пользователя.

Примеры

Запрос

Ниже показан пример запроса.

GET https://graph.microsoft.com/v1.0/me/people

Отклик

Ниже показан пример отклика.

HTTP/1.1 200 OK
Content-type: application/json

{
    "value": [
        {
            "id": "33b43a5b-87d6-41ec-91f8-a2610048105f",
            "displayName": "Marketing",
            "givenName": null,
            "surname": null,
            "birthday": "",
            "personNotes": "",
            "isFavorite": false,
            "jobTitle": null,
            "companyName": null,
            "yomiCompany": "",
            "department": null,
            "officeLocation": null,
            "profession": "",
            "userPrincipalName": "",
            "imAddress": null,
            "scoredEmailAddresses": [
                {
                    "address": "Marketing@contoso.com",
                    "relevanceScore": 30.0
                }
            ],
            "phones": [],
            "postalAddresses": [],
            "websites": [],
            "personType": {
                "class": "Group",
                "subclass": "UnifiedGroup"
            }
        },
        {
            "id": "e3d0513b-449e-4198-ba6f-bd97ae7cae85",
            "displayName": "Isaiah Langer",
            "givenName": "Isaiah",
            "surname": "Langer",
            "birthday": "",
            "personNotes": "",
            "isFavorite": false,
            "jobTitle": "Web Marketing Manager",
            "companyName": null,
            "yomiCompany": "",
            "department": "Sales & Marketing",
            "officeLocation": "20/1101",
            "profession": "",
            "userPrincipalName": "IsaiahL@contoso.com",
            "imAddress": "sip:isaiahl@contoso.com",
            "scoredEmailAddresses": [
                {
                    "address": "IsaiahL@contoso.com",
                    "relevanceScore": 20.0
                }
            ],
            "phones": [
                {
                    "type": "business",
                    "number": "+1 918 555 0101"
                }
            ],
            "postalAddresses": [],
            "websites": [],
            "personType": {
                "class": "Person",
                "subclass": "OrganizationUser"
            }
        }
    ]
}

Связанные материалы

  • Last updated on