Personen auflisten

Namespace: microsoft.graph

Rufen Sie eine Liste von Personenobjekten ab, sortiert nach ihrer Relevanz für den Benutzer, die durch die Kommunikations- und Zusammenarbeitsmuster des Benutzers sowie durch Geschäftsbeziehungen bestimmt wird.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

HTTP-Anforderung

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

Optionale Abfrageparameter

Diese Methode unterstützt die folgenden OData-Abfrageparameter, um die Antwort anzupassen.

Anforderungsheader

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 200 OK Antwortcode und eine Auflistung von Personenobjekten im Antworttext zurück.

Beispiele

Durchsuchen

Die Anforderungen in diesem Abschnitt erhalten die für den angemeldeten Benutzer () relevantesten Personen (/me), basierend auf Kommunikation, Zusammenarbeit und Geschäftsbeziehungen.

Standardmäßig gibt jede Antwort 10 Datensätze zurück, aber Sie können dies mit dem Parameter $top ändern. Für diese Anforderungen ist die Einstellung "People. Leseberechtigung.

Anforderung

Im Folgenden finden Sie ein Beispiel für die Standardanforderung.

GET https://graph.microsoft.com/beta/me/people

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.People.GetAsync();

// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
people, err := graphClient.Me().People().Get(context.Background(), nil)

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

PersonCollectionResponse result = graphClient.me().people().get();

const options = {
	authProvider,
};

const client = Client.init(options);

let people = await client.api('/me/people')
	.version('beta')
	.get();

<?php
use Microsoft\Graph\Beta\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->people()->get()->wait();

Import-Module Microsoft.Graph.Beta.People

# A UPN can also be used as -UserId.
Get-MgBetaUserPerson -UserId $userId

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.me.people.get()

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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,
            "title": null,
            "companyName": null,
            "yomiCompany": "",
            "department": null,
            "officeLocation": null,
            "profession": "",
            "mailboxType": "GroupMailbox",
            "personType": "ModernGroup",
            "userPrincipalName": "",
            "emailAddresses": [
                {
                    "address": "Marketing@contoso.com",
                    "rank": 30
                }
            ],
            "phones": [],
            "postalAddresses": [],
            "websites": [],
            "sources": [
                {
                    "type": "Directory"
                }
            ]
        },
        {
            "id": "e3d0513b-449e-4198-ba6f-bd97ae7cae85",
            "displayName": "Isaiah Langer",
            "givenName": "Isaiah",
            "surname": "Langer",
            "birthday": "",
            "personNotes": "",
            "isFavorite": false,
            "title": "Web Marketing Manager",
            "companyName": null,
            "yomiCompany": "",
            "department": "Sales & Marketing",
            "officeLocation": "20/1101",
            "profession": "",
            "mailboxType": "Mailbox",
            "personType": "Person",
            "userPrincipalName": "IsaiahL@contoso.com",
            "emailAddresses": [
                {
                    "address": "IsaiahL@contoso.com",
                    "rank": 20
                }
            ],
            "phones": [
                {
                    "type": "business",
                    "number": "+1 918 555 0101"
                }
            ],
            "postalAddresses": [],
            "websites": [],
            "sources": [
                {
                    "type": "Directory"
                }
            ]
        }
    ]
}

Anfordern einer nachfolgenden Seite von Personen

Wenn die erste Antwort nicht die vollständige Liste der relevanten Personen enthält, können Sie eine zweite Anforderung unter Verwendung von $top und $skip stellen, um weitere Seiten mit Informationen anzufordern. Wenn die vorherige Anforderung zusätzliche Informationen enthält, erhält die folgende Anforderung die nächste Seite der Personen vom Server.

GET https://graph.microsoft.com/beta/me/people/?$top=10&$skip=10

Sortieren der Antwort

Standardmäßig werden die Personen in der Antwort nach ihrer Relevanz für die Abfrage sortiert. Sie können die Reihenfolge der Personen in der Antwort mit dem $orderby-Parameter ändern. Diese Abfrage wählt die für Sie relevantesten Personen aus, sortiert sie nach ihrem Anzeigenamen und gibt dann die ersten 10 Personen auf der sortierten Liste zurück.

GET https://graph.microsoft.com/beta/me/people/?$orderby=DisplayName

Ändern der Anzahl der zurückgegebenen Personen und der zurückgegebenen Felder

Sie können die Anzahl der Personen ändern, die in der Antwort zurückgegeben wird, indem Sie den $top-Parameter festlegen.

Im folgenden Beispiel werden die 1.000 Personen angefordert, /medie für am relevantesten sind. Die Anforderung schränkt auch die Menge der vom Server zurückgesendeten Daten ein, indem nur der Anzeigename der Person angefordert wird.

GET https://graph.microsoft.com/beta/me/people/?$top=1000&$select=DisplayName

Auswahl der zurückzugebenden Felder

Sie können die Menge der vom Server zurückgegebenen Daten einschränken, indem Sie mit dem Parameter $select ein oder mehrere Felder auswählen. Das Feld @odata.id wird immer zurückgegeben.

Im folgenden Beispiel wird die Antwort der 10 relevantesten Personen auf DisplayName und EmailAddress beschränkt.

GET https://graph.microsoft.com/beta/me/people/?$select=DisplayName,EmailAddresses

Verwendung eines Filters zur Begrenzung der Antwort

Sie können den $filter-Parameter zum Einschränken der Antwort auf diejenigen Personen einschränken, deren Datensätze die angegebenen Kriterien enthalten.

Die folgende Abfrage beschränkt die Antwort auf Personen mit der Quelle "Verzeichnis".

GET https://graph.microsoft.com/beta/me/people/?$filter=Sources/Any (source: source/Type  eq 'Directory')

Auswählen der Felder, die in einer gefilterten Antwort zurückgegeben werden sollen

Sie können die $select- und $filter-Parameter gemeinsam verwenden, um eine benutzerdefinierte Liste der für den Benutzer relevanten Personen zu erstellen und nur die Felder abzurufen, die Ihre Anwendung benötigt.

Im folgenden Beispiel werden DisplayName und EmailAddress von Personen abgerufen, deren Anzeigename dem angegebenen Namen entspricht. In diesem Beispiel werden nur Personen zurückgegeben, deren Anzeigename "Nestor Kellum" ist.

+GET https://graph.microsoft.com/beta/me/people/?$select=DisplayName,EmailAddresses&$filter=DisplayName eq 'Nestor Kellum'

Durchsuchen von Personen

Die Anforderungen in diesem Abschnitt erhalten auch die Personen, die für den angemeldeten Benutzer am relevantesten sind (/me). Für Suchanfragen ist der Befehl "People. Leseberechtigung.

Verwenden der Suche zum Auswählen von Personen

Verwenden Sie den $search-Parameter zum Auswählen von Personen, die bestimmte Kriterien erfüllen.

Die folgende Suchabfrage liefert Personen, die für /me sie relevant sind, deren Vorname oder Nachname mit dem Buchstaben "j" beginnt.

GET https://graph.microsoft.com/beta/me/people/?$search=j

Mit der Suche ein relevantes Thema angeben

Die folgende Anforderung gibt Personen zurück, deren Name " /me ma" enthält und die eine Zuordnung zu "Featureplanung" haben.

GET https://graph.microsoft.com/beta/me/people/?$search="ma topic: feature planning"

Fuzzy-Suche durchführen

Die folgende Anfrage führt eine Suche nach einer Person namens "Hermaini Hall" durch. Da es eine Person namens "Herminia Hull" gibt, die für den angemeldeten Benutzer relevant ist, werden die Informationen für "Herminia Hull" zurückgegeben.

GET https://graph.microsoft.com/beta/me/people/?$search="hermaini hall"

Verwandte Personen

Mit der folgenden Anforderung werden die Personen abgerufen, die für eine andere Person in der organization des Benutzers am relevantesten sind. Für diese Anforderung ist User.ReadBasic.All for People erforderlich. Read.All Berechtigung. In diesem Beispiel werden die relevanten Personen von Nestor Kellum angezeigt.

GET https://graph.microsoft.com/beta/users('nestork@contoso.com')/people/