Agregar datos personalizados a usuarios mediante extensiones abiertas

Artículo
02/14/2024

En este tutorial, se inclina cómo usar extensiones abiertas.

Imagine que está creando una aplicación que está disponible en varias plataformas cliente, como escritorio y dispositivos móviles. Quiere permitir que los usuarios configuren su experiencia de interfaz de usuario para que sea coherente independientemente del dispositivo que usen para iniciar sesión en la aplicación.

En este escenario, en este artículo se muestra cómo:

Represente información de perfil móvil sobre el usuario mediante extensiones abiertas.
Realizar una consulta al usuario y devolver el perfil móvil.
Cambie la información de perfil móvil del usuario almacenada en la extensión abierta.
Eliminar la información de perfil móvil del usuario.

Nota:

Además de los usuarios, también se admiten extensiones abiertas y se pueden administrar para otros tipos de recursos.

Requisitos previos

Para reproducir los pasos de este artículo, necesita los siguientes privilegios:

Inicie sesión en un cliente de API, como Graph Explorer y el usuario para el que desea almacenar el perfil móvil.
Conceda a la aplicación el permiso delegado User.ReadWrite para el usuario que ha iniciado sesión.

Paso 1. Agregar información de perfil móvil

El usuario inicia sesión en la aplicación y configura su apariencia. La configuración de la aplicación debe ser móvil para que el usuario reciba la misma experiencia en cualquier dispositivo desde el que inicie sesión en la aplicación. La aplicación llama a Microsoft Graph mediante la ejecución de la siguiente solicitud para agregar la información del perfil móvil al objeto de recurso del usuario que ha iniciado sesión.

Solicitud

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


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new OpenTypeExtension
{
	OdataType = "microsoft.graph.openTypeExtension",
	ExtensionName = "com.contoso.roamingSettings",
	AdditionalData = new Dictionary<string, object>
	{
		{
			"theme" , "dark"
		},
		{
			"color" , "purple"
		},
		{
			"lang" , "Japanese"
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Extensions.PostAsync(requestBody);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users extensions create --user-id {user-id} --body '{\
    "@odata.type":"microsoft.graph.openTypeExtension",\
    "extensionName":"com.contoso.roamingSettings",\
    "theme":"dark",\
    "color":"purple",\
    "lang":"Japanese"\
}\
'



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


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

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


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

OpenTypeExtension extension = new OpenTypeExtension();
extension.setOdataType("microsoft.graph.openTypeExtension");
extension.setExtensionName("com.contoso.roamingSettings");
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("theme", "dark");
additionalData.put("color", "purple");
additionalData.put("lang", "Japanese");
extension.setAdditionalData(additionalData);
Extension result = graphClient.me().extensions().post(extension);


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);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\OpenTypeExtension;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new OpenTypeExtension();
$requestBody->setOdataType('microsoft.graph.openTypeExtension');
$requestBody->setExtensionName('com.contoso.roamingSettings');
$additionalData = [
	'theme' => 'dark',
	'color' => 'purple',
	'lang' => 'Japanese',
];
$requestBody->setAdditionalData($additionalData);

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


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


from msgraph import GraphServiceClient
from msgraph.generated.models.open_type_extension import OpenTypeExtension

graph_client = GraphServiceClient(credentials, scopes)

request_body = OpenTypeExtension(
	odata_type = "microsoft.graph.openTypeExtension",
	extension_name = "com.contoso.roamingSettings",
	additional_data = {
			"theme" : "dark",
			"color" : "purple",
			"lang" : "Japanese",
	}
)

result = await graph_client.me.extensions.post(request_body)

Respuesta

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('376bdbfc-e41f-4082-a8cf-b31731465eeb')/extensions/$entity",
    "@odata.type": "#microsoft.graph.openTypeExtension",
    "extensionName": "com.contoso.roamingSettings",
    "theme": "dark",
    "color": "purple",
    "lang": "Japanese",
    "id": "com.contoso.roamingSettings"
}

Paso 2. Recuperar información de perfil móvil

Cuando el usuario inicia sesión en la aplicación desde otro dispositivo, la aplicación llama a Microsoft Graph para recuperar los detalles del perfil del usuario y expandir la propiedad de navegación extensiones para obtener su configuración de itinerancia y, a continuación, usa estos datos para proporcionar la misma experiencia que en el otro dispositivo.

Solicitud

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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Select = new string []{ "id","displayName","mail","mobilePhone" };
	requestConfiguration.QueryParameters.Expand = new string []{ "extensions" };
});


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users get --user-id {user-id} --select "id,displayName,mail,mobilePhone" --expand "extensions"



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


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

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


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

User result = graphClient.me().get(requestConfiguration -> {
	requestConfiguration.queryParameters.select = new String []{"id", "displayName", "mail", "mobilePhone"};
	requestConfiguration.queryParameters.expand = new String []{"extensions"};
});


const options = {
	authProvider,
};

const client = Client.init(options);

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


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Me\MeRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

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


$result = $graphServiceClient->me()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Users

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


from msgraph import GraphServiceClient
from msgraph.generated.me.me_request_builder import MeRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)

query_params = MeRequestBuilder.MeRequestBuilderGetQueryParameters(
		select = ["id","displayName","mail","mobilePhone"],
		expand = ["extensions"],
)

request_configuration = MeRequestBuilder.MeRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.me.get(request_configuration = request_configuration)

Respuesta

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users(id,displayName,mail,mobilePhone,extensions())/$entity",
    "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET me?$select=signInActivity,accountEnabled",
    "id": "376bdbfc-e41f-4082-a8cf-b31731465eeb",
    "displayName": "Raul Razo",
    "mail": null,
    "mobilePhone": null,
    "extensions@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('376bdbfc-e41f-4082-a8cf-b31731465eeb')/extensions",
    "extensions": [
        {
            "@odata.type": "#microsoft.graph.openTypeExtension",
            "extensionName": "com.contoso.roamingSettings",
            "theme": "dark",
            "color": "purple",
            "lang": "Japanese",
            "id": "com.contoso.roamingSettings"
        }
    ]
}

Paso 3. Cambio de la información del perfil móvil

El usuario puede optar por cambiar la información de su perfil móvil. La aplicación llama a Microsoft Graph mediante la ejecución de la consulta siguiente. La solicitud devuelve un código de respuesta 204 No Content.

También debe incluir todas las propiedades en el cuerpo de la solicitud, incluso si desea actualizar solo un subconjunto de ellas. De lo contrario, Microsoft Graph quita las propiedades que no se pasan. Para eliminar datos, pero mantener una propiedad, establezca el valor nullde propiedad en .

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

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


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Extension
{
	AdditionalData = new Dictionary<string, object>
	{
		{
			"theme" , "light"
		},
		{
			"color" , "yellow"
		},
		{
			"lang" , "Swahili"
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Extensions["{extension-id}"].PatchAsync(requestBody);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users extensions patch --user-id {user-id} --extension-id {extension-id} --body '{\
    "theme":"light",\
    "color":"yellow",\
    "lang":"Swahili"\
}\
'



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


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

extensions, err := graphClient.Me().Extensions().ByExtensionId("extension-id").Patch(context.Background(), requestBody, nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Extension extension = new Extension();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("theme", "light");
additionalData.put("color", "yellow");
additionalData.put("lang", "Swahili");
extension.setAdditionalData(additionalData);
Extension result = graphClient.me().extensions().byExtensionId("{extension-id}").patch(extension);


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);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Extension;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

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

$result = $graphServiceClient->me()->extensions()->byExtensionId('extension-id')->patch($requestBody)->wait();


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


from msgraph import GraphServiceClient
from msgraph.generated.models.extension import Extension

graph_client = GraphServiceClient(credentials, scopes)

request_body = Extension(
	additional_data = {
			"theme" : "light",
			"color" : "yellow",
			"lang" : "Swahili",
	}
)

result = await graph_client.me.extensions.by_extension_id('extension-id').patch(request_body)

Paso 4. Eliminación del perfil móvil de un usuario

El usuario decide que ya no quiere un perfil móvil. Para eliminar la propiedad de extensión, la aplicación llama a Microsoft Graph mediante la ejecución de la siguiente solicitud. La solicitud devuelve un código de respuesta 204 No Content.

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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Me.Extensions["{extension-id}"].DeleteAsync();


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users extensions delete --user-id {user-id} --extension-id {extension-id}



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



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


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.me().extensions().byExtensionId("{extension-id}").delete();


const options = {
	authProvider,
};

const client = Client.init(options);

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


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->me()->extensions()->byExtensionId('extension-id')->delete()->wait();


Import-Module Microsoft.Graph.Users

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


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


await graph_client.me.extensions.by_extension_id('extension-id').delete()

Agregar datos personalizados a usuarios mediante extensiones abiertas

Requisitos previos

Paso 1. Agregar información de perfil móvil

Solicitud

Respuesta

Paso 2. Recuperar información de perfil móvil

Solicitud

Respuesta

Paso 3. Cambio de la información del perfil móvil

Paso 4. Eliminación del perfil móvil de un usuario

Comentarios

Comentarios

Recursos adicionales

Agregar datos personalizados a usuarios mediante extensiones abiertas

Requisitos previos

Paso 1. Agregar información de perfil móvil

Solicitud

Respuesta

Paso 2. Recuperar información de perfil móvil

Solicitud

Respuesta

Paso 3. Cambio de la información del perfil móvil

Paso 4. Eliminación del perfil móvil de un usuario

Contenido relacionado

Comentarios

Comentarios

Recursos adicionales