title	Update onPremisesDirectorySynchronization
description	Update the properties of an onPremisesDirectorySynchronization object.
author	dhanyahk
ms.reviewer	damaiya,vifernan,awsdev
ms.localizationpriority	medium
ms.subservice	entra-directory-management
doc_type	apiPageType
ms.date	10/31/2024
ms.custom	sfi-ga-blocked

Update onPremisesDirectorySynchronization

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Update the properties of an onPremisesDirectorySynchronization object.

[!INCLUDE national-cloud-support]

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]

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. Global Administrator is the only role supported for this operation.

HTTP request

PATCH /directory/onPremisesSynchronization/{id}

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

[!INCLUDE table-intro]

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.

Response

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

Examples

Request

The following example shows a request.

HTTP

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

{
  "configuration": {
    "accidentalDeletionPrevention": {
      "synchronizationPreventionType": "enabledForCount",
      "alertThreshold": 500
    },
    "synchronizationInterval": "PT30M",
    "customerRequestedSynchronizationInterval": "PT1H"
  },
  "features": {
    "groupWriteBackEnabled": true
  }
}