Freigeben über

Personen auflisten

  • Artikel

Namespace: microsoft.graph

Dient zum Abrufen einer Sammlung von person-Objekten, die nach ihrer Relevanz für den Benutzer sortiert sind, die von den Mustern bei Kommunikation, Zusammenarbeit und den Geschäftsbeziehungen des Benutzers abhängt.

Sie können diese Informationen über die Personen-API abrufen. Beispiele finden Sie im Abschnitt Beispiele und im Artikel Verwenden der Personen-API, um Informationen zu den Personen zu erhalten, die für Sie am relevantesten sind.

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 OData-Abfrageparameter zur Anpassung der Antwort.

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. Dies 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. Die Antwort kann ein Personenobjekt oder eine Auflistung von Personenobjekten enthalten.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

Antwort

Das folgende Beispiel zeigt die Antwort.

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

Verwandte Inhalte