Skip to content

Latest commit

 

History

History
133 lines (108 loc) · 4.25 KB

synchronization-synchronizationschema-update.md

File metadata and controls

133 lines (108 loc) · 4.25 KB
Raw
title description ms.localizationpriority doc_type author ms.subservice
Update synchronizationSchema
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.
medium
apiPageType
ArvindHarinder1
entra-applications

Update synchronizationSchema

Namespace: microsoft.graph

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.

[!INCLUDE permissions-table]

[!INCLUDE rbac-synchronization-apis]

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.

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.

Example

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/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

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 204 No Content