Personen auflisten

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

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

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

Globaler Dienst	US Government L4	US Government L5 (DOD)	China, betrieben von 21Vianet
✅	✅	✅	✅

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp	Berechtigungen mit den geringsten Berechtigungen	Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto)	People.Read	People.Read.All
Delegiert (persönliches Microsoft-Konto)	People.Read	Nicht verfügbar.
Anwendung	People.Read.All	Nicht verfügbar.

HTTP-Anforderung

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

Optionale Abfrageparameter

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

Name	Wert	Beschreibung
$filter	Zeichenfolge	Dient zum Einschränken der Antwort auf diejenigen Personen, deren Datensätze die angegebenen Kriterien enthalten.
$orderby	Zeichenfolge	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.
$search	Zeichenfolge	Dient für die Suche nach Personen anhand des Namens oder des Alias. Unterstützt Fuzzyübereinstimmung. Parameter funktioniert nur für die Suche nach den relevanten Personen des angemeldeten Benutzers, nicht für die Suche nach Personen, die für andere Benutzer relevant sind. Unterstützt auch das Schlüsselwort topic, um Personen anhand von Themen zu finden, die aus E-Mail-Gesprächen mit dieser Person extrahiert wurden. Informationen und Beispiele finden Sie im Abschnitt Ausführen einer Fuzzysuche unter Verwenden der Personen-API zum Abrufen von Informationen zu den Personen, die für Sie am relevantesten sind.
$select	string	Durch Trennzeichen getrennte Liste der Eigenschaften, die in die Antwort eingeschlossen werden sollen. Um eine optimale Leistung zu erzielen, wählen Sie nur die Teilmenge der erforderlichen Eigenschaften aus.
$skip	int	Überspringen Sie die ersten n Ergebnisse, die für paging nützlich sind. Das Überspringen wird bei Verwendung von $search nicht unterstützt.
$top	int	Die maximale Anzahl von Ergebnissen, die auf einer Ergebnisseite zurückgegeben werden sollen. Weitere Informationen finden Sie unter top-Parameter.

Anforderungsheader

Name	Beschreibung
Authorization	Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.
Annehmen	application/json

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

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

Beispiele

Durchsuchen

Die Anforderungen in diesem Abschnitt erhalten die Personen, die für den angemeldeten Benutzer am relevantesten sind (/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. Diese Anforderungen erfordern die Personen. Leseberechtigung.

Anforderung

Es folgt ein Beispiel für die Standardanforderung.

HTTP

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

C#

// 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();

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta users people list --user-id {user-id}

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Go

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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



people, err := graphClient.Me().People().Get(context.Background(), nil)

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Java

// 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();

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

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

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


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


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

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

PowerShell

Import-Module Microsoft.Graph.Beta.People

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

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Python

from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


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

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

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 mit $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, die für am relevantesten sind /me. 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 vom Server zurückgegebene Datenmenge begrenzen, indem Sie den Parameter $select verwenden, um ein oder mehrere Felder auszuwählen. Das Feld @odata.id wird immer zurückgegeben.

Im folgenden Beispiel wird die Antwort auf displayName und EmailAddress der 10 relevantesten Personen 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 enthalten auch die Personen, die für den angemeldeten Benutzer am relevantesten sind (/me). Search Anforderungen erfordern die Personen. 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 gibt Personen zurück, die für relevant sind, für /me deren GivenName oder Surname 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, die für relevant sind /me , deren Name "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 Anforderung sucht nach einer Person namens "Hermaini Hall". Da für den angemeldeten Benutzer eine Person namens "Herminia Hull" relevant ist, werden die Informationen für "Herminia Hull" zurückgegeben.

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

Verwandte Personen

Die folgende Anforderung ruft die Personen ab, die für eine andere Person im organization des Benutzers am relevantesten sind. Für diese Anforderung ist user.ReadBasic.All für Personen 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/