Outlook-Benutzerfoto REST-API-Verweis (Version 2.0)

  • Artikel

Gilt für: Exchange Online | Office 365

Mit der Benutzerfoto-API können Sie das Foto eines Benutzers herunterladen oder einstellen, dessen Postfach durch Azure Active Directory auf Office 365 gesichert ist.

Hinweis

Die Benutzerfoto-API unterstützt keine Postfächer für Endverbraucher in Microsoft-Konto-Domänen wie Hotmail.com, Live.com, MSN.com, Outlook.com und Passport.com.

Kein Interesse an v2.0 der API? Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zu Office 365 REST API-Verweis und wählen Sie die gewünschte Version aus.

Verwendung der Benutzerfoto-REST-API

Authentifizierung

Wie andere Outlook-REST-API sollten Sie für jede Anforderung an die Outlook-Benutzerfoto-API ein gültiges Zugriffstoken angeben. Sie müssen Ihre App registriert und identifiziert haben und die entsprechende Autorisierung erhalten haben, ein Zugriffstoken abzurufen.

Sie können mehr über einige optimierte Registrierungs- und Autorisierungsoptionen für Sie herausfinden. Beachten Sie dies, wenn Sie mit den spezifischen Operationen in der Benutzerfoto-API fortfahren.

Version der API

Diese API wurde von der Vorschauversion auf den Status Allgemeine Verfügbarkeit (GA) befördert. Sie wird in den v2.0 und Beta-Versionen der Outlook-REST-API unterstützt.

Ziel-Benutzer

Der Ziel-Benutzer kann der angemeldete Benutzer oder ein durch eine Benutzer-ID angegebener Benutzer sein.

Weitere Informationen zur Verwendung dieser API und Informationen, die allen Untergruppen der Outlook-REST-API gemeinsam sind, finden Sie unter Verwendung der Outlook-REST-API.

Benutzerfoto-Operationen

Mit den Benutzerfoto-Operationen können Sie die Foto-Metadaten und den Foto-Stream eines Benutzers im Binärformat abrufen und das Benutzerfoto einstellen.

Foto-Metadaten abrufen

Erhalten Sie Informationen über das gewünschte Benutzerfoto, das den Inhaltstyp, den eTag sowie die Breite und Höhe in Pixeln enthält.

Erforderlicher Bereich

Verwenden Sie einen der folgenden Bereiche, um Foto-Metadaten des angegebenen Benutzers zu erhalten, der der angemeldete Benutzer sein kann:

  • user.readbasic.all
  • user.read.all
  • user.readwrite.all

Sie können auch den folgenden Bereich verwenden, um Foto-Metadaten speziell des angemeldeten Benutzers zu erhalten:

  • user.read

Rufen Sie die Metadaten für das größte verfügbare Foto ab

GET https://outlook.office.com/api/v2.0/me/photo
GET https://outlook.office.com/api/v2.0/Users('{user_id}')/photo
Optionaler Parameter Typ Beschreibung
URL-Parameter
user_id Zeichenfolge Die E-Mail-Adresse des Benutzers.

Beispielanfrage

Diese Anforderung ruft die Metadaten des Benutzerfotos des angemeldeten Benutzers ab.

GET https://outlook.office.com/api/v2.0/me/photo

Daten der Beispielantwort

Die folgenden Antwortdaten zeigen die Foto-Metadaten. Der HTTP-Antwort-Code ist 200.

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/photo/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-7d04-b48b-20075df800e5@1717622f-1d94-c0d4-9d74-f907ad6677b4')/photo",
    "@odata.mediaContentType": "image/jpeg",
    "@odata.mediaEtag": "\"BA09D118\"",
    "Id": "240X240",
    "Width": 240,
    "Height": 240
}

Die folgenden Antwortdaten zeigen den Inhalt einer Antwort, wenn noch kein Foto für den Benutzer hochgeladen wurde. Der HTTP-Antwort-Code ist 200.

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/photo/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-7d04-b48b-20075df800e5@1717622f-1d94-c0d4-9d74-f907ad6677b4')/photo",
    "@odata.mediaContentType": "image/gif",
    "@odata.mediaEtag": "",
    "Id": "1X1",
    "Width": 1,
    "Height": 1
}

Foto abrufen

Rufen Sie das Benutzerfoto des angegebenen Benutzers ab.

Dieser Vorgang ermöglicht es einem Mandanten-Administrator, einer App den Abruf eines Benutzerfotos eines beliebigen Nutzers im Mandanten zu ermöglichen.

Erforderlicher Bereich

Verwenden Sie einen der folgenden Bereiche, um das Foto des angegebenen Benutzers zu erhalten, der der angemeldete Benutzer sein kann:

  • user.readbasic.all
  • user.read.all
  • user.readwrite.all

Sie können auch den folgenden Bereich verwenden, um das Foto speziell des angemeldeten Benutzers zu erhalten:

  • user.read
  • user.readwrite

Rufen Sie die größte verfügbare Größe ab

GET https://outlook.office.com/api/v2.0/me/photo/$value
GET https://outlook.office.com/api/v2.0/Users('{user_id}')/photo/$value
Optionaler Parameter Typ Beschreibung
URL-Parameter
user_id Zeichenfolge Die E-Mail-Adresse des Benutzers.

Beispielanfrage

Diese Anforderung ruft das Foto für den angemeldeten Benutzer ab.

GET https://outlook.office.com/api/v2.0/me/photo/$value
Content-Type: image/jpg

Antwortdaten

Enthält die binären Daten des angeforderten Fotos. Der HTTP-Antwortcode ist 200.

Benutzerfoto einstellen

Weisen Sie dem angemeldeten Benutzer ein Foto zu. Das Foto sollte binär sein. Es ersetzt jedes vorhandene Foto für diesen Benutzer.

In Version 2.0 können Sie PATCH oder PUT für diesen Vorgang verwenden.

Erforderlicher Bereich

Verwenden Sie den folgenden Bereich, um das Foto des angemeldeten Benutzers einzustellen:

  • user.readwrite
PATCH https://outlook.office.com/api/v2.0/me/photo/$value
PATCH https://outlook.office.com/api/v2.0/users('{user_id}')/photo/$value

PUT https://outlook.office.com/api/v2.0/me/photo/$value
PUT https://outlook.office.com/api/v2.0/users('{user_id}')/photo/$value
Optionaler Parameter Typ Beschreibung
URL-Parameter
user_id Zeichenfolge Die E-Mail-Adresse des Benutzers.

Beispielanfrage

PATCH https://outlook.office.com/api/v2.0/me/photo/$value
Content-Type: image/jpeg

Fügen Sie die Binärdaten des Fotos in den Text der Anfrage ein.

Antwortdaten

Eine erfolgreiche Anforderung gibt HTTP 200 zurück.

Nächste Schritte

Egal, ob Sie bereit sind, eine App zu erstellen oder einfach nur mehr darüber erfahren möchten, wir haben alles im Griff.

Oder erfahren Sie mehr über die Verwendung der Office 365-Plattform: