Répertorier les personnes

  • Article

Espace de noms: microsoft.graph

Récupérer une collection d’objets person classés selon leur pertinence pour l’utilisateur (user), laquelle est déterminée par les relations professionnelles et les modèles de communication et de collaboration de l’utilisateur.

Vous pouvez obtenir ces informations via l’API Personnes. Pour obtenir des exemples, consultez la section Exemples et l’article Utiliser l’API Personnes pour obtenir des informations sur les personnes les plus pertinentes pour vous.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ✅ ✅ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) People.Read People.Read.All
Déléguée (compte Microsoft personnel) People.Read Non disponible.
Application People.Read.All Non disponible.

Requête HTTP

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

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.

Nom Valeur Description
$filter string Limite la réponse uniquement aux contacts dont l’enregistrement contient les critères spécifiés.
$orderby string Par défaut, les contacts de la réponse sont triés selon leur pertinence par rapport à votre requête. Vous pouvez modifier l’ordre des contacts dans la réponse à l’aide du paramètre $orderby.
$search string Rechercher des personnes par nom ou alias. Prend en charge la correspondance approximative. Le paramètre fonctionne pour rechercher uniquement les contacts pertinents de l’utilisateur connecté, pas ceux d’autres utilisateurs. Prend également en charge le mot clé topic permettant de rechercher des contacts en fonction de sujets extraits de conversations par e-mail avec cette personne. Pour obtenir des informations et des exemples, consultez la section Effectuer une recherche approximative dans Utiliser l’API Personnes pour obtenir des informations sur les personnes les plus pertinentes pour vous.
$select string Liste de propriétés séparées par des virgules à inclure dans la réponse. Pour des performances optimales, sélectionnez uniquement le sous-ensemble des propriétés nécessaires.
$skip int Ignorez les n premiers résultats, utiles pour la pagination. Cela n’est pas pris en charge lors de l’utilisation de $search.
$top int Nombre maximal de résultats à retourner sur une page de résultats. Pour plus d’informations, consultez paramètre top.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Accepter application/json

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et une collection d’objets person dans le corps de la réponse. La réponse peut contenir un objet person ou une collection d’objets person.

Exemples

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

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"
            }
        }
    ]
}

Contenu connexe