cross_tenant_access_policy_partners_identity_synchronization

Creates, updates, deletes, gets or lists a cross_tenant_access_policy_partners_identity_synchronization resource.

Overview

Name	cross_tenant_access_policy_partners_identity_synchronization
Type	Resource
Id	entra_id.policies.cross_tenant_access_policy_partners_identity_synchronization

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	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	object	Defines whether users can be synchronized from the partner tenant. Key. (title: crossTenantUserSyncInbound)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cross_tenant_access_policy_configuration_partner_tenant_id		Get the user synchronization policy of a partner-specific configuration.
replace	replace	cross_tenant_access_policy_configuration_partner_tenant_id		Create a cross-tenant user synchronization policy for a partner-specific configuration.
delete	delete	cross_tenant_access_policy_configuration_partner_tenant_id	If-Match	Delete the user synchronization policy for a partner-specific configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cross_tenant_access_policy_configuration_partner_tenant_id	string	The unique identifier of crossTenantAccessPolicyConfigurationPartner
If-Match	string	ETag

SELECT examples

get

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

SELECT
displayName,
tenantId,
userSyncInbound
FROM entra_id.policies.cross_tenant_access_policy_partners_identity_synchronization
WHERE cross_tenant_access_policy_configuration_partner_tenant_id = '{{ cross_tenant_access_policy_configuration_partner_tenant_id }}' -- required
;

REPLACE examples

replace

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

REPLACE entra_id.policies.cross_tenant_access_policy_partners_identity_synchronization
SET 
displayName = '{{ displayName }}',
tenantId = '{{ tenantId }}',
userSyncInbound = '{{ userSyncInbound }}',
WHERE 
cross_tenant_access_policy_configuration_partner_tenant_id = '{{ cross_tenant_access_policy_configuration_partner_tenant_id }}' --required
RETURNING
displayName,
tenantId,
userSyncInbound;

DELETE examples

delete

Delete the user synchronization policy for a partner-specific configuration.

DELETE FROM entra_id.policies.cross_tenant_access_policy_partners_identity_synchronization
WHERE cross_tenant_access_policy_configuration_partner_tenant_id = '{{ cross_tenant_access_policy_configuration_partner_tenant_id }}' --required
AND If-Match = '{{ If-Match }}'
;