Create identitySynchronization

Namespace: microsoft.graph


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.

Create a cross-tenant user synchronization policy for a partner-specific configuration.


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

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

  • Hybrid Identity Administrator

HTTP request

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

Request headers

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

Request body

In the request body, supply a JSON representation of the crossTenantIdentitySyncPolicyPartner object.

You can specify the following properties when creating a crossTenantIdentitySyncPolicyPartner.

Property Type Description
displayName String Display name for the cross-tenant user synchronization policy. Use the name of the partner Azure AD tenant to easily identify the policy. Optional.
userSyncInbound crossTenantUserSyncInbound Determines whether users are synchronized from the partner tenant.


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



The following is an example of a request.

Content-Type: application/json

  "displayName": "Fabrikam",
    "isSyncAllowed": true


HTTP/1.1 204 No Content