| title | crossTenantIdentitySyncPolicyPartner resource type |
|---|---|
| description | Defines the cross-tenant policy for synchronization of users and optionally groups from a partner tenant. |
| author | rolyon |
| ms.localizationpriority | medium |
| ms.subservice | entra-sign-in |
| doc_type | resourcePageType |
| toc.title | Partner user and group sync settings |
| ms.date | 07/22/2024 |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Defines the cross-tenant policy for synchronization of users and optionally groups from a partner tenant. Use this user and group synchronization policy to streamline collaboration between users in a multi-tenant organization by automating the creation, update, and deletion of users and groups from one tenant to another.
Inherits from policyDeletableItem.
| Method | Return type | Description |
|---|---|---|
| Create | None | Create a cross-tenant user and optionally group synchronization policy for a partner-specific configuration. |
| Get | crossTenantIdentitySyncPolicyPartner | Get the user and group synchronization policy of a partner-specific configuration. |
| Update | None | Update the user and group synchronization policy of a partner-specific configuration. |
| Delete | None | Delete the user and group synchronization policy for a partner-specific configuration. |
| List deleted policies | crossTenantIdentitySyncPolicyPartner collection | List all deleted partner-specific configuration policies. |
| Get deleted policy | crossTenantIdentitySyncPolicyPartner | Get a single deleted partner-specific configuration policy. |
| Permanently delete deleted policy | None | Permanently delete a deleted partner-specific configuration policy. |
| Restore deleted policy | crossTenantIdentitySyncPolicyPartner | Restore the user and group synchronization policy for a partner-specific configuration. |
| Property | Type | Description |
|---|---|---|
| deletedDateTime | DateTimeOffset | Shows the last date and time the policy was deleted. |
| displayName | String | Display name for the cross-tenant user and group synchronization policy. Use the name of the partner Microsoft Entra tenant to easily identify the policy. Optional. |
| groupSyncInbound | crossTenantGroupSyncInbound | Defines whether groups can be synchronized from a partner tenant. |
| tenantId | String | Tenant identifier for the partner Microsoft Entra organization. Key. Read-only. |
| userSyncInbound | crossTenantUserSyncInbound | Defines whether users can be synchronized from the partner tenant. |
None.
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.crossTenantIdentitySyncPolicyPartner",
"deletedDateTime": "String (timestamp)",
"displayName": "String",
"externalCloudAuthorizedApplicationId": "String",
"groupSyncInbound": {"@odata.type": "microsoft.graph.crossTenantGroupSyncInbound"},
"tenantId": "String (identifier)",
"userSyncInbound": {"@odata.type": "microsoft.graph.crossTenantUserSyncInbound"}
}