directorySetting 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.
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 guests 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 might allow existing members of groups to invite guests; but an individual group setting can override and not allow the operation.
Group-specific settings apply to only Microsoft 365 groups.
Tip
The /v1.0 version of this resource is named groupSetting.
Methods
| Method | Return Type | Description |
|---|---|---|
| List | directorySetting collection | List properties of all setting objects. |
| Create | directorySetting | Create a setting object based on a directorySettingTemplate. |
| Get | directorySetting | Read properties of a specific setting object. |
| Update | directorySetting | Update a setting object. Only settingValues can be changed in an update. |
| Delete | None | Delete a setting object. |
Properties
| 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. |
Relationships
None
JSON representation
The following JSON representation shows the resource type.
{
"displayName": "string",
"id": "string (identifier)",
"templateId": "string",
"values": [{"@odata.type": "microsoft.graph.settingValue"}]
}