groupWritebackConfiguration 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.

Indicates whether writeback of cloud groups to on-premises Active Directory is enabled and the target group type for the on-premises group.

By default, all Microsoft Entra security groups aren't writeback enabled. For Microsoft 365 groups, the default settings that are defined by the properties of this resource can be overwritten by the NewUnifiedgroupWritebackDefault directory setting object.

Inherits from writebackConfiguration.

Properties

Property Type Description
isEnabled Boolean Indicates whether writeback of cloud groups to on-premises Active Directory is enabled. Nullable. Default value is true for Microsoft 365 groups and false for security groups. Inherited from writebackConfiguration.
onPremisesGroupType String Indicates the target on-premises group type the cloud object is written back as. Nullable. The possible values are: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup.
  1. If the cloud group is a unified (Microsoft 365) group, this property can be one of the following: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup.
  2. Microsoft Entra security groups can be written back as universalSecurityGroup.
  3. If isEnabled or the NewUnifiedGroupWritebackDefault group setting is true but this property isn't explicitly configured:
    • Microsoft 365 groups are written back as universalDistributionGroup by default
    • Security groups are written back as universalSecurityGroup by default

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.groupWritebackConfiguration",
  "isEnabled": "Boolean",
  "onPremisesGroupType": "String"
}