Vue d’ensemble de l’API de configuration utilisateur dans Microsoft Graph (préversion)

L’API de configuration utilisateur dans Microsoft Graph permet à votre application de stocker et de récupérer des données de configuration par dossier, ainsi que le contenu d’une boîte aux lettres Exchange Online. Un objet userConfiguration (élément associé au dossier, FAI) est associé à un dossier de messagerie spécifique et identifié par une clé unique dans ce dossier. Chaque objet s’applique à un dossier unique plutôt qu’à la boîte aux lettres entière. Cette étendue permet à votre application de conserver l’état proche du contenu auquel elle se rapporte.

L’API permet à votre application de contrôler entièrement la création, la lecture, la mise à jour et la suppression des objets userConfiguration , et prend en charge plusieurs styles de charge utile qui vous permettent de stocker le format qui convient le mieux à votre scénario : données binaires arbitraires, XML sérialisé ou paires clé-valeur fortement typées.

Pourquoi intégrer l’API de configuration utilisateur ?

Stocker l’état et les paramètres de l’application par dossier

De nombreuses applications ont besoin d’un emplacement fiable pour conserver les paramètres ou l’état d’un dossier de messagerie spécifique. Par exemple, l’ID du dernier élément synchronisé pour un outil de synchronisation de boîte de réception, les préférences d’affichage d’un dossier personnalisé ou les indicateurs de fonctionnalité limités à un dossier. L’API de configuration utilisateur donne à votre application un emplacement de stockage dédié et résident dans la boîte aux lettres pour ce type de données, de sorte que vous n’avez pas à gérer un magasin externe distinct.

Conserver les métadonnées de l’application avec le contenu de la boîte aux lettres

Les objets de configuration utilisateur se trouvent à l’intérieur de la boîte aux lettres. Par conséquent, les données se situent à proximité du contenu auquel elles se rapportent, et les mêmes contrôles d’accès qui protègent l’autre contenu de la boîte aux lettres de l’utilisateur protègent également ces données. Ce modèle de stockage rend l’API adaptée aux métadonnées d’application qui doivent rester liées à un dossier spécifique.

Choisir le style de charge utile adapté à vos données

La ressource userConfiguration prend en charge trois propriétés de charge utile, et vous pouvez choisir la forme appropriée pour votre scénario :

• Utilisez binaryData pour le contenu binaire arbitraire.
• Utilisez xmlData pour le code XML sérialisé.
• Utilisez structuredData pour stocker des paires clé-valeur typées sans sérialiser votre propre format. Les types complexes structuredDataEntry et structuredDataEntryTypedValue modélisent les types valeur pris en charge.

Un seul objet userConfiguration peut contenir n’importe quelle combinaison de ces propriétés. Vous pouvez combiner des styles de charge utile à mesure que votre application évolue.

Référence d’API

Vous recherchez la référence de l’API pour ce service ? Consultez le type de ressource userConfiguration et ses méthodes prises en charge.

Étapes suivantes

• Explorez le type de ressource userConfiguration et ses méthodes prises en charge (Create, Get, Update, Delete).
• Essayez l’API de configuration utilisateur dans Graph Explorer.