Actualizar synchronizationSchema

Espacio de nombres: microsoft.graph

Actualice el esquema de sincronización de un trabajo o plantilla determinados. Este método reemplaza completamente el esquema actual por el proporcionado en la solicitud. Para actualizar el esquema de una plantilla, realice la llamada en el objeto de aplicación. Debe ser el propietario de la aplicación.

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	Synchronization.ReadWrite.All	CustomSecAttributeProvisioning.ReadWrite.All
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	Application.ReadWrite.OwnedBy	CustomSecAttributeProvisioning.ReadWrite.All, Synchronization.ReadWrite.All

Para configurar el aprovisionamiento de aplicaciones o el aprovisionamiento controlado por RR. HH., al usuario que realiza la llamada también se le debe asignar al menos el rol de directorioAdministrador de aplicaciones o Administrador de aplicaciones en la nube.

Para configurar Microsoft Entra Cloud Sync, al usuario que realiza la llamada también se le debe asignar al menos el rol de directorio Administrador de identidades híbridas.

Solicitud HTTP

PUT /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
PUT /applications/{id}/synchronization/templates/{templateId}/schema

Encabezados de solicitud

Nombre	Tipo	Descripción
Authorization	string	{token} de portador. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione el objeto synchronizationSchema por el que reemplazar el esquema existente.

Respuesta

Si se ejecuta correctamente, devuelve un código de 204 No Content respuesta. No devuelve nada en el cuerpo de la respuesta.

Ejemplo

Solicitud

En el ejemplo siguiente se muestra la solicitud.

Nota: El objeto de solicitud que se muestra aquí se abrevia para mejorar la legibilidad. Proporcione todas las propiedades en una llamada real.

HTTP

PUT https://graph.microsoft.com/v1.0/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
Content-type: application/json

{
    "directories": [
        {
            "name": "Azure Active Directory",
            "objects": [
                {
                    "name": "User",
                    "attributes": [
                        {
                            "name": "userPrincipalName",
                            "type": "string"
                        }
                    ]
                },
            ]
        },
        {
            "name": "Salesforce",
        }
    ],
    "synchronizationRules":[
        {
            "name": "USER_TO_USER",
            "sourceDirectoryName": "Azure Active Directory",
            "targetDirectoryName": "Salesforce",
            "objectMappings": [
                {
                    "sourceObjectName": "User",
                    "targetObjectName": "User",
                    "attributeMappings": [
                        {
                            "source": {},
                            "targetAttributeName": "userName"
                        },
                    ]
                },
            ]
        },
    ]
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const synchronizationSchema = {
    directories: [
        {
            name: 'Azure Active Directory',
            objects: [
                {
                    name: 'User',
                    attributes: [
                        {
                            name: 'userPrincipalName',
                            type: 'string'
                        }
                    ]
                },
            ]
        },
        {
            name: 'Salesforce',
        }
    ],
    synchronizationRules: [
        {
            name: 'USER_TO_USER',
            sourceDirectoryName: 'Azure Active Directory',
            targetDirectoryName: 'Salesforce',
            objectMappings: [
                {
                    sourceObjectName: 'User',
                    targetObjectName: 'User',
                    attributeMappings: [
                        {
                            source: {},
                            targetAttributeName: 'userName'
                        },
                    ]
                },
            ]
        },
    ]
};

await client.api('/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema')
	.put(synchronizationSchema);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content