Update crossTenantIdentitySyncPolicyPartner

Namespace: microsoft.graph

Update the user synchronization policy of a partner-specific configuration.


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) Policy.ReadWrite.CrossTenantAccess Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Policy.ReadWrite.CrossTenantAccess Not available.

The signed-in user must also be assigned the following minimum directory role:

  • Security Administrator

HTTP request

PATCH /policies/crossTenantAccessPolicy/partners/{id}/identitySynchronization

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
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
displayName String Display name for the cross-tenant user synchronization policy. Generally, this should be the tenant name of the partner Microsoft Entra organization. Optional.
userSyncInbound crossTenantUserSyncInbound Determines whether users can be synchronized from the partner tenant. false causes any current user synchronization from the source tenant to the target tenant to stop. This property has no impact on existing users who have already been synchronized.


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



The following example shows a request.

PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/partners/90e29127-71ad-49c7-9ce8-db3f41ea06f1/identitySynchronization
Content-Type: application/json

  "userSyncInbound": {
    "isSyncAllowed": true


The following example shows the response.

HTTP/1.1 204 No Content