Create identitySynchronization

Namespace: microsoft.graph

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

Permissions

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 supported.
Application	Policy.ReadWrite.CrossTenantAccess

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

• Security 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 you create a crossTenantIdentitySyncPolicyPartner.

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

Response

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

Examples

Request

The following is an example of a request.

HTTP

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

{
  "displayName": "Fabrikam",
  "userSyncInbound": {
    "isSyncAllowed": true
  }
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Policies.CrossTenantAccessPolicy.Partners.Item.IdentitySynchronization.IdentitySynchronizationPutRequestBody
{
	AdditionalData = new Dictionary<string, object>
	{
		{
			"displayName" , "Fabrikam"
		},
		{
			"userSyncInbound" , new 
			{
				IsSyncAllowed = true,
			}
		},
	},
};
await graphClient.Policies.CrossTenantAccessPolicy.Partners["{crossTenantAccessPolicyConfigurationPartner-tenantId}"].IdentitySynchronization.PutAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/Policies/CrossTenantAccessPolicy/Partners/Item/IdentitySynchronization"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewIdentitySynchronizationPutRequestBody()
additionalData := map[string]interface{}{
	"displayName" : "Fabrikam", 
userSyncInbound := graphmodels.New()
	isSyncAllowed := true
userSyncInbound.SetIsSyncAllowed(&isSyncAllowed) 
	requestBody.SetUserSyncInbound(userSyncInbound)
}
requestBody.SetAdditionalData(additionalData)

graphClient.Policies().CrossTenantAccessPolicy().Partners().ByPartnerId("crossTenantAccessPolicyConfigurationPartner-tenantId").IdentitySynchronization().Put(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

CrossTenantIdentitySyncPolicyPartner crossTenantIdentitySyncPolicyPartner = new CrossTenantIdentitySyncPolicyPartner();
crossTenantIdentitySyncPolicyPartner.displayName = "Fabrikam";
CrossTenantUserSyncInbound userSyncInbound = new CrossTenantUserSyncInbound();
userSyncInbound.isSyncAllowed = true;
crossTenantIdentitySyncPolicyPartner.userSyncInbound = userSyncInbound;

graphClient.policies().crossTenantAccessPolicy().partners("90e29127-71ad-49c7-9ce8-db3f41ea06f1").identitySynchronization()
	.buildRequest()
	.put(crossTenantIdentitySyncPolicyPartner);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const crossTenantIdentitySyncPolicyPartner = {
  displayName: 'Fabrikam',
  userSyncInbound: {
    isSyncAllowed: true
  }
};

await client.api('/policies/crossTenantAccessPolicy/partners/90e29127-71ad-49c7-9ce8-db3f41ea06f1/identitySynchronization')
	.put(crossTenantIdentitySyncPolicyPartner);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new IdentitySynchronizationPutRequestBody();
$additionalData = [
		'displayName' => 'Fabrikam', 
		'userSyncInbound' => $requestBody = new UserSyncInbound();
		$requestBody->setIsSyncAllowed(true);


$requestBody->setUserSyncInbound($userSyncInbound);

];
$requestBody->setAdditionalData($additionalData);




$graphServiceClient->policies()->crossTenantAccessPolicy()->partners()->byPartnerId('crossTenantAccessPolicyConfigurationPartner-tenantId')->identitySynchronization()->put($requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

HTTP/1.1 204 No Content