groupSetting resource type

Namespace: microsoft.graph

Group settings define the configurations that can be used to customize the tenant-wide and object-specific restrictions and allowed behavior. For examples, you can block word lists for group display names or define whether guest users are allowed to be group owners.

By default, all groups inherit the preset defaults. To change the default settings, you must create a new settings object using the groupSettingTemplates. When the same setting is defined at both the tenant-wide and to a specific group, the group-level setting overrides the tenant-wide setting. For example, the tenant-wide setting may allow guests to be invited by existing members of groups, but an individual group setting can override and not allow guests to be invited by members of the group.

Group settings apply to only Microsoft 365 groups.

Tip

The /beta version of this resource is named directorySetting.

Methods

Method Return Type Description
Create setting groupSetting Create a setting object based on a groupSettingTemplate.
Get setting groupSetting Read properties of a specific setting object.
List settings groupSetting collection List properties of all setting objects.
Update setting groupSetting Update groupsetting object.
Delete setting None Delete a setting object.

Properties

Property Type Description
displayName String Display name of this group of settings, which comes from the associated template.
id String Unique identifier for these settings. Read-only.
templateId String Unique identifier for the tenant-level groupSettingTemplates object that's been customized for this group-level settings object. Read-only.
values settingValue collection Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced groupSettingTemplates object.

Relationships

None.

JSON representation

Here is a JSON representation of the resource.

{
  "displayName": "String",
  "id": "String (identifier)",
  "templateId": "String",
  "values": [{ "@odata.type": "microsoft.graph.settingValue" }]
}