crossTenantIdentitySyncPolicyPartner resource type

Namespace: microsoft.graph

Important

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.

Defines the cross-tenant policy for synchronization of users from a partner tenant. Use this user synchronization policy to streamline collaboration between users in a multi-tenant organization by automating the creation, update, and deletion of users from one tenant to another.

Methods

Method	Return type	Description
Create	None	Create a cross-tenant user synchronization policy for a partner-specific configuration.
Get	crossTenantIdentitySyncPolicyPartner	Get the user synchronization policy of a partner-specific configuration.
Update	None	Update the user synchronization policy of a partner-specific configuration.
Delete	None	Delete the user synchronization policy for a partner-specific configuration.

Properties

Property	Type	Description
displayName	String	Display name for the cross-tenant user synchronization policy. Use the name of the partner Microsoft Entra tenant to easily identify the policy. Optional.
tenantId	String	Tenant identifier for the partner Microsoft Entra organization. Read-only.
userSyncInbound	crossTenantUserSyncInbound	Defines whether users can be synchronized from the partner tenant. Key.

Relationships

None.

JSON representation

The following JSON representation shows the resource type. The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.crossTenantIdentitySyncPolicyPartner",
  "displayName": "String",
  "tenantId": "String (identifier)",
  "userSyncInbound": {
    "@odata.type": "microsoft.graph.crossTenantUserSyncInbound"
  }
}