directorySetting resource type

Namespace: microsoft.graph


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.

Directory 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 entities inherit the preset defaults. To change the default settings, you must create a new settings object using the directorySettingTemplates. When the same setting is defined at both the tenant-wide and to a specific group, the entity-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.


The /v1.0 version of this resource is named groupSetting.


Method Return Type Description
Create setting directorySetting Create a setting object based on a directorySettingTemplate.
Get setting directorySetting Read properties of a specific setting object.
List settings directorySetting collection List properties of all setting objects.
Update setting directorySetting Update a setting object. Only settingValues can be changed in an update.
Delete setting None Delete a setting object.


Property Type Description
displayName string Display name of this group of settings, which comes from the associated template. Read-only.
id string Unique identifier for these settings. Read-only.
templateId string Unique identifier for the template used to create this group of settings. Read-only.
values settingValue collection Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced directorySettingTemplates object.



JSON representation

Here is a JSON representation of the resource.

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