Update synchronizationSchema

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Update the synchronization schema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Synchronization.ReadWrite.All	CustomSecAttributeProvisioning.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Application.ReadWrite.OwnedBy	CustomSecAttributeProvisioning.ReadWrite.All, Synchronization.ReadWrite.All

Important

In delegated scenarios with work or school accounts, the signed-in user must be an owner or member of the group or be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

• Application Administrator
• Cloud Application Administrator
• Hybrid Identity Administrator - to configure Microsoft Entra Cloud Sync

HTTP Request

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

Request headers

Name	Type	Description
Authorization	string	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

In the request body, supply the synchronizationSchema object to replace the existing schema with.

Response

If successful, returns a 204 No Content response code. It doesn't return anything in the response body.

Examples

Example 1: Update schema

Request

The following example shows a request.

Note: The request object shown here is shortened for readability. Supply all the properties in an actual call.

HTTP

PUT https://graph.microsoft.com/beta/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')
	.version('beta')
	.put(synchronizationSchema);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 204 No Content

Example 2: Add attribute "CustomAttribute" to the target system schema

Request

The following example shows a request. It assumes that the attribute "CustomAttribute" doesn't exist in the target directory schema. If it does exist, the attribute is updated.

Note: The request object shown here is shortened for readability. Supply all the properties in an actual call.

HTTP

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

{
   "directories":[
      {
         "id":"09760868-cafb-47ac-9031-0a3262300427",
         "name":"customappsso",
         "objects":[
            {
               "name":"User",
               "attributes":[
                  {
                     "anchor":false,
                     "caseExact":false,
                     "defaultValue":null,
                     "flowNullValues":false,
                     "multivalued":false,
                     "mutability":"ReadWrite",
                     "name":"urn:ietf:params:scim:schemas:extension:CustomExtensionName:2.0:User:CustomAttribute",
                     "required":false,
                     "type":"String",
                     "apiExpressions":[],
                     "metadata":[],
                     "referencedObjects":[]
                  }
               ]
            }
         ]
      }
   ]
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const synchronizationSchema = {
   directories: [
      {
         id: '09760868-cafb-47ac-9031-0a3262300427',
         name: 'customappsso',
         objects: [
            {
               name: 'User',
               attributes: [
                  {
                     anchor: false,
                     caseExact: false,
                     defaultValue: null,
                     flowNullValues: false,
                     multivalued: false,
                     mutability: 'ReadWrite',
                     name: 'urn:ietf:params:scim:schemas:extension:CustomExtensionName:2.0:User:CustomAttribute',
                     required: false,
                     type: 'String',
                     apiExpressions: [],
                     metadata: [],
                     referencedObjects: []
                  }
               ]
            }
         ]
      }
   ]
};

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

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 204 No Content

Example 3: Add a new attribute mapping to the synchronization rules

Request

The following example shows a request. The synchornizationSchema has a one-to-many relationship between targetAttributeName and source attributes. If your schema doesn't have "timezone" as a target attribute, the service adds a new mapping for extensionAttribute11 --> timezone. If your application has timezone as a target attribute in the schema, the service throws an error because an attribute can only be mapped as a target once. In addition, the attribute must exist in the schema before it can be added to the mappings.

Note: The request object shown here is shortened for readability. Supply all the properties in an actual call.

HTTP

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

{
   "@odata.type":"#microsoft.graph.synchronizationSchema",
   "synchronizationRules":[
      {
         "defaultValue":"",
         "exportMissingReferences":false,
         "flowBehavior":"FlowWhenChanged",
         "flowType":"Always",
         "matchingPriority":0,
         "source":{
            "expression":"[extensionAttribute11]",
            "name":"extensionAttribute11",
            "parameters":[],
            "type":"Attribute"
         },
         "targetAttributeName":"timezone"
      }
   ]
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const synchronizationSchema = {
   '@odata.type':'#microsoft.graph.synchronizationSchema',
   synchronizationRules: [
      {
         defaultValue: '',
         exportMissingReferences: false,
         flowBehavior: 'FlowWhenChanged',
         flowType: 'Always',
         matchingPriority: 0,
         source: {
            expression: '[extensionAttribute11]',
            name: 'extensionAttribute11',
            parameters: [],
            type: 'Attribute'
         },
         targetAttributeName: 'timezone'
      }
   ]
};

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

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 204 No Content