directorySetting resource type

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

Directory settings can be created based on the available directorySettingTemplates, and changed from their preset defaults. These settings can govern entity or feature behaviors, both at a tenant-wide level or at a specific entity level. When the same setting is defined at both the tenant-wide and specific entity level, the specific entity level setting may opt-out from the tenant-wide setting. For example, the tenant-wide setting may allow guests to be invited by existing members of groups, but a specific group setting may opt-out and not allow guests to be invited by members of the group. Currently system defined settings are only govern Office groups behavior.

Note: The /beta version of the directorySetting resource type only applies to groups. The /v1.0 version has been renamed to groupSetting.

Methods

Method Return Type Description
Create setting directorySetting Create a setting object based on a directorySettingTemplate. The POST request must provide settingValues for all the settings defined in the template.
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.

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. Must contain and set all the settings defined in the template.

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"}]
}