Update onPremisesDirectorySynchronization

Namespace: microsoft.graph

Update the properties of an onPremisesDirectorySynchronization object.

This API is supported in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) OnPremDirectorySynchronization.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application OnPremDirectorySynchronization.ReadWrite.All

For delegated scenarios, the user needs to be assigned the Global Administrator role.

HTTP request

PATCH /directory/onPremisesSynchronization/{id}

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply only the values for properties that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property Type Description
configuration onPremisesDirectorySynchronizationConfiguration Consists of configurations that can be fine-tuned and impact the on-premises directory synchronization process for a tenant.
features onPremisesDirectorySynchronizationFeature Consists of directory synchronization features that can be enabled or disabled.


If successful, this method returns a 204 No Content response code.



The following is an example of a request.

PATCH https://graph.microsoft.com/beta/directory/onPremisesSynchronization/{id}
Content-Type: application/json
Content-length: 293

  "configuration": {
    "accidentalDeletionPrevention": {
      "synchronizationPreventionType": "enabledForCount",
      "alertThreshold": 500
  "features": {
    "groupWriteBackEnabled": true


The following is an example of the response

HTTP/1.1 204 No Content