multiTenantOrganizationIdentitySyncPolicyTemplate resource type

  • Article

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 an optional cross-tenant access policy template with user synchronization settings for multitenant organization tenants. Each tenant has its own template. For more information, see crossTenantIdentitySyncPolicyPartner resource type.

  • If your tenant is joining a multitenant organization, the template is applicable to the user synchronization settings for all multitenant organization tenants.
  • If another tenant joins your multitenant organization, the template is applicable only to the user synchronization settings of the newly joined multitenant organization tenant.

Whether the template is applied to the user synchronization settings of relevant tenants is configurable with the templateApplicationLevel property.

  • If the template is configured to apply, it is only applied to user synchronization properties where the corresponding template property has a non-null value.

In its default and unconfigured state, where all template properties (other than templateApplicationLevel) are null, the template has no effect on user synchronization settings.

Methods

Method Return type Description
Get multiTenantOrganizationIdentitySyncPolicyTemplate Get the user synchronization settings of the template.
Update multiTenantOrganizationIdentitySyncPolicyTemplate Update the user synchronization settings of the template.
Reset None Reset the user synchronization settings of the template to the default values.

Properties

Property Type Description
id String ID of the template. Key.
templateApplicationLevel templateApplicationLevel Specifies whether the template will be applied to user synchronization settings of certain tenants. The possible values are: none, newPartners, existingPartners, unknownFutureValue. You can also specify multiple values like newPartners,existingPartners (default). none indicates the template isn't applied to any new or existing partner tenants. newPartners indicates the template is applied to new partner tenants. existingPartners indicates the template is applied to existing partner tenants, those who already had partner-specific user synchronization settings in place.
userSyncInbound crossTenantUserSyncInbound Defines whether users can be synchronized from the partner tenant.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.multiTenantOrganizationIdentitySyncPolicyTemplate",
  "templateApplicationLevel": "String",
  "userSyncInbound": {
    "@odata.type": "microsoft.graph.crossTenantUserSyncInbound"
  }
}