Ajout de données personnalisées à des utilisateurs à l’aide des extensions d’ouverture

Cet article explique comment utiliser des extensions ouvertes.

Imaginez que vous créez une application qui est disponible sur plusieurs plateformes clientes, telles que les ordinateurs de bureau et les appareils mobiles. Vous souhaitez permettre aux utilisateurs de configurer leur expérience d’interface utilisateur pour qu’elle soit cohérente quel que soit le périphérique utilisé pour se connecter à votre application.

Pour ce scénario, cet article vous explique comment procéder aux opérations suivantes :

1. Ajouter une extension d’ouverture représentant certaines informations de profil d’itinérance sur l’utilisateur.
2. Interroger l’utilisateur et renvoyer le profil d’itinérance.
3. Modifier les informations de profil d’itinérance de l’utilisateur (la valeur de l’extension d’ouverture).
4. Supprimer les informations de profil d’itinérance de l’utilisateur.

Remarque

Outre les utilisateurs, les extensions ouvertes sont également prises en charge et peuvent être gérées pour d’autres types de ressources.

1. Ajout d’informations de profil d’itinérance

L’utilisateur se connecte à l’application et configure l’apparence de l’application. Ces paramètres d’application doivent être itinérants afin de garantir la même expérience à l’utilisateur sur n’importe quel appareil utilisé pour se connecter à l’application. L’application appelle Microsoft Graph en exécutant la requête suivante pour ajouter les informations de profil d’itinérance à une ressource utilisateur.

Demande

HTTP

POST https://graph.microsoft.com/v1.0/me/extensions
Content-type: application/json

{
    "@odata.type":"microsoft.graph.openTypeExtension",
    "extensionName":"com.contoso.roamingSettings",
    "theme":"dark",
    "color":"purple",
    "lang":"Japanese"
}

C#

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Extension
{
	OdataType = "microsoft.graph.openTypeExtension",
	AdditionalData = new Dictionary<string, object>
	{
		{
			"extensionName" , "com.contoso.roamingSettings"
		},
		{
			"theme" , "dark"
		},
		{
			"color" , "purple"
		},
		{
			"lang" , "Japanese"
		},
	},
};
var result = await graphClient.Me.Extensions.PostAsync(requestBody);

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const extension = {
    '@odata.type':'microsoft.graph.openTypeExtension',
    extensionName: 'com.contoso.roamingSettings',
    theme: 'dark',
    color: 'purple',
    lang: 'Japanese'
};

await client.api('/me/extensions')
	.post(extension);

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

Java

Snippet not available

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

Activer

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)

requestBody := graphmodels.NewExtension()
additionalData := map[string]interface{}{
	"extensionName" : "com.contoso.roamingSettings", 
	"theme" : "dark", 
	"color" : "purple", 
	"lang" : "Japanese", 
}
requestBody.SetAdditionalData(additionalData)

result, err := graphClient.Me().Extensions().Post(context.Background(), requestBody, nil)

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

PowerShell

Import-Module Microsoft.Graph.Users

$params = @{
	"@odata.type" = "microsoft.graph.openTypeExtension"
	ExtensionName = "com.contoso.roamingSettings"
	Theme = "dark"
	Color = "purple"
	Lang = "Japanese"
}

# A UPN can also be used as -UserId.
New-MgUserExtension -UserId $userId -BodyParameter $params

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new Extension();
$requestBody->set@odatatype('microsoft.graph.openTypeExtension');

$additionalData = [
'extensionName' => 'com.contoso.roamingSettings', 
'theme' => 'dark', 
'color' => 'purple', 
'lang' => 'Japanese', 
];
$requestBody->setAdditionalData($additionalData);




$requestResult = $graphServiceClient->me()->extensions()->post($requestBody);

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

Réponse

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.openTypeExtension",
    "extensionName": "com.contoso.roamingSettings",
    "id": "com.contoso.roamingSettings",
    "theme": "dark",
    "color": "purple",
    "lang": "Japanese"
}

2. Récupération des informations de profil d’itinérance

Lorsque l’utilisateur se connecte à l’application à partir d’un autre appareil, l’application appelle Microsoft Graph pour récupérer les détails du profil de l’utilisateur et développer la propriété de navigation des extensions pour obtenir ses paramètres d’itinérance.

Demande

HTTP

GET https://graph.microsoft.com/v1.0/me?$select=id,displayName,mail,mobilePhone&$expand=extensions

C#

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Me.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Select = new string []{ "id","displayName","mail","mobilePhone" };
	requestConfiguration.QueryParameters.Expand = new string []{ "extensions" };
});

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let user = await client.api('/me')
	.expand('extensions')
	.select('id,displayName,mail,mobilePhone')
	.get();

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

User user = graphClient.me()
	.buildRequest()
	.expand("extensions")
	.select("id,displayName,mail,mobilePhone")
	.get();

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)

requestParameters := &graphconfig.MeRequestBuilderGetQueryParameters{
	Select: [] string {"id","displayName","mail","mobilePhone"},
	Expand: [] string {"extensions"},
}
configuration := &graphconfig.MeRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

result, err := graphClient.Me().Get(context.Background(), configuration)

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

PowerShell

Import-Module Microsoft.Graph.Users

# A UPN can also be used as -UserId.
Get-MgUser -UserId $userId -Property "id,displayName,mail,mobilePhone" -ExpandProperty "extensions" 

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestConfiguration = new MeRequestBuilderGetRequestConfiguration();

$queryParameters = new MeRequestBuilderGetQueryParameters();
$queryParameters->select = ["id","displayName","mail","mobilePhone"];
$queryParameters->expand = ["extensions"];

$requestConfiguration->queryParameters = $queryParameters;


$requestResult = $graphServiceClient->me()->get($requestConfiguration);

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

Réponse

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "84b80893-8749-40a3-97b7-68513b600544",
    "displayName": "John Smith",
    "mail": "john@contoso.com",
    "mobilePhone": "1-555-6589",
    "extensions": [
        {
            "@odata.type": "#microsoft.graph.openTypeExtension",
            "extensionName": "com.contoso.roamingSettings",
            "id": "com.contoso.roamingSettings",
            "theme": "dark",
            "color": "purple",
            "lang": "Japanese"
        }
    ]
}

3. Modification des informations de profil d’itinérance

L’utilisateur peut choisir de modifier ses informations de profil d’itinérance. L’application appelle Microsoft Graph en exécutant la requête suivante.

Demande

HTTP

PATCH https://graph.microsoft.com/v1.0/me/extensions/com.contoso.roamingSettings
Content-type: application/json

{
    "theme":"light",
    "color":"yellow",
    "lang":"Swahili"
}

C#

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Extension
{
	AdditionalData = new Dictionary<string, object>
	{
		{
			"theme" , "light"
		},
		{
			"color" , "yellow"
		},
		{
			"lang" , "Swahili"
		},
	},
};
var result = await graphClient.Me.Extensions["{extension-id}"].PatchAsync(requestBody);

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const extension = {
    theme: 'light',
    color: 'yellow',
    lang: 'Swahili'
};

await client.api('/me/extensions/com.contoso.roamingSettings')
	.update(extension);

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

Java

Snippet not available

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

Activer

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)

requestBody := graphmodels.NewExtension()
additionalData := map[string]interface{}{
	"theme" : "light", 
	"color" : "yellow", 
	"lang" : "Swahili", 
}
requestBody.SetAdditionalData(additionalData)

result, err := graphClient.Me().ExtensionsById("extension-id").Patch(context.Background(), requestBody, nil)

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

PowerShell

Import-Module Microsoft.Graph.Users

$params = @{
	Theme = "light"
	Color = "yellow"
	Lang = "Swahili"
}

# A UPN can also be used as -UserId.
Update-MgUserExtension -UserId $userId -ExtensionId $extensionId -BodyParameter $params

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new Extension();
$additionalData = [
'theme' => 'light', 
'color' => 'yellow', 
'lang' => 'Swahili', 
];
$requestBody->setAdditionalData($additionalData);




$requestResult = $graphServiceClient->me()->extensionsById('extension-id')->patch($requestBody);

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

Réponse

HTTP/1.1 204 No content

4. Suppression du profil d’itinérance d’un utilisateur

L’utilisateur décide qu’il ne veut plus d’un profil itinérant. Il le supprime et l’application appelle Microsoft Graph en exécutant la requête suivante.

Demande

HTTP

DELETE https://graph.microsoft.com/v1.0/me/extensions/com.contoso.roamingSettings

C#

var graphClient = new GraphServiceClient(requestAdapter);

await graphClient.Me.Extensions["{extension-id}"].DeleteAsync();

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/me/extensions/com.contoso.roamingSettings')
	.delete();

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

graphClient.me().extensions("com.contoso.roamingSettings")
	.buildRequest()
	.delete();

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

Activer

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


graphClient.Me().ExtensionsById("extension-id").Delete(context.Background(), nil)

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

PowerShell

Import-Module Microsoft.Graph.Users

# A UPN can also be used as -UserId.
Remove-MgUserExtension -UserId $userId -ExtensionId $extensionId

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);


$graphServiceClient->me()->extensionsById('extension-id')->delete();

Pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider, consultez la documentation du KIT de développement logiciel (SDK).

Réponse

HTTP/1.1 204 No content

Voir aussi

• Ajout de données personnalisées à des ressources à l’aide des extensions
• Ajout de données personnalisées à des groupes à l’aide des extensions de schéma
• type de ressource openTypeExtension