Référence des API REST de Photo utilisateur Outlook (version 2.0)

S’applique à : Exchange Online | Office 365

L'API de photo d'utilisateur vous permet de télécharger ou de définir la photo d'un utilisateur dont la boîte aux lettres est sécurisée via Azure Active Directory sous Office 365.

Note

L’API de photo d’utilisateur ne prend pas en charge les boîtes aux lettres consommateur dans les domaines de comptes Microsoft, tels que Hotmail.com, Live.com, MSN.com, Outlook.com et Passport.com.

La version 2.0 de l’API ne vous intéresse pas ? Dans la table des matières sur la gauche, accédez à la section Référence API REST Office 365 et sélectionnez la version souhaitée.

Utilisation de l’API REST de photo d’utilisateur

Authentification

Comme les autres API REST Outlook, pour chaque demande adressée à l'API de photo d'utilisateur Outlook, vous devez inclure un jeton d'accès valide. Pour obtenir un jeton d'accès, vous devez avoir enregistré et identifié votre application et obtenu l'autorisation appropriée.

Vous pouvez en savoir plus à propos de certaines options d'enregistrement et d'autorisation simplifiées pour vous. Rappelez-vous en lorsque vous réalisez certaines opérations dans l'API de photo d'utilisateur.

Version de l'API

Cette API a été promue de la préversion au statut de disponibilité générale (GA). Elle est prise en charge dans les versions v2.0 et bêta de l’API REST d’Outlook.

Utilisateur cible

L'utilisateur cible peut être l'utilisateur connecté ou un utilisateur spécifié par un ID utilisateur.

Pour plus d'informations sur l'utilisation de cette API et obtenir des informations communes à tous les sous-ensembles de l'API REST Outlook, reportez-vous à la rubrique Utiliser l'API REST Outlook.

Opérations de photo d’utilisateur

Les opérations de photo d’utilisateur vous permettent d’obtenir les métadonnées et les flux de photos d’un utilisateur au format binaire, et de définir la photo de cet utilisateur.

Obtenez des métadonnées de photo

Obtenez des informations sur la photo d’utilisateur demandée, qui comprend le type de contenu, le eTag, la largeur et la hauteur en pixels.

Étendue requise

Utilisez l’une des étendues suivantes pour obtenir des métadonnées de photo de l’utilisateur spécifié, qui peut être l’utilisateur connecté :

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

Vous pouvez également utiliser l'étendue suivante pour obtenir des métadonnées de photo de l'utilisateur spécifiquement connecté :

  • user.read

Obtenez les métadonnées pour la plus grande photo disponible

GET https://outlook.office.com/api/v2.0/me/photo
GET https://outlook.office.com/api/v2.0/Users('{user_id}')/photo
Paramètre facultatif Type Description
Paramètres URL
user_id chaîne Adresse de messagerie de l’utilisateur.

Exemple de requête

Cette requête obtient les métadonnées de la photo de l’utilisateur connecté.

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

Exemple de données de réponse

Les données de réponse suivantes montrent les métadonnées de la photo. Le code de la réponse HTTP est 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
}

Les données de réponse suivantes montrent le contenu d’une réponse lorsqu’une photo n’a pas encore été téléchargée pour l’utilisateur. Le code de la réponse HTTP est 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
}

Obtenir une photo

Obtenez la photo de l'utilisateur de l'utilisateur spécifié.

Cette opération permet à un administrateur client de laisser une application obtenir la photo de l’utilisateur d’un quelconque utilisateur du client.

Étendue requise

Utilisez l’une des étendues suivantes pour obtenir des métadonnées de photo de l’utilisateur spécifié, qui peut être l’utilisateur connecté :

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

Vous pouvez également utiliser l'étendue suivante pour obtenir la photo de l'utilisateur connecté en particulier :

  • user.read
  • user.readwrite

Obtenez la plus grande taille disponible

GET https://outlook.office.com/api/v2.0/me/photo/$value
GET https://outlook.office.com/api/v2.0/Users('{user_id}')/photo/$value
Paramètre facultatif Type Description
Paramètres URL
user_id chaîne Adresse de messagerie de l’utilisateur.

Exemple de requête

Exemple de requête

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

Données de réponse

Contient les données binaires de la photo demandée. Le code de la réponse HTTP est 200.

Définir la photo de l’utilisateur

Attribuez une photo à l’utilisateur connecté. La photo doit être en binaire. Elle remplace toute photo existante pour cet utilisateur.

Vous pouvez utiliser PATCH ou PUT pour cette opération dans la version 2.0.

Étendue requise

Utilisez l’étendue suivante pour définir la photo de l’utilisateur connecté :

  • 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
Paramètre facultatif Type Description
Paramètres URL
user_id chaîne Adresse de messagerie de l’utilisateur.

Exemple de requête

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

Incluez les données binaires de la photo dans le corps de la requête.

Données de réponse

Une requête réussie renvoie HTTP 200.

Étapes suivantes

Que vous soyez prêt à commencer à créer une application ou que vous souhaitiez simplement en apprendre plus, nous avons ce qu’il vous faut.

Ou, pour en savoir plus sur l’utilisation de la plateforme Office 365 :