Create a group setting

• 5/4/2019
• 2 minutes to read
• Contributors
  • 
  • 
  • 
  • 

Use this API to create a new setting, based on the templates available in groupSettingTemplates. These settings can be at the tenant-level or at the group level. The creation request must provide settingValues for all the settings defined in the template. For group-specific settings, only the setting governing whether members of a group can invite guest users can be set. This will govern this behavior once the ability to add guest users to a group is generally available.

For a list of templates and the properties they support in v1.0, use a groupSettingTemplate query (For beta endpoints, call directorySettingTemplates.)

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

HTTP request

POST /groupSettings
POST /groups/{id}/settings

Request headers

Request body

In the request body, supply a JSON representation of groupSetting object. However, the display name for the setting will be set based on the referenced settings template name.

Response

If successful, this method returns 201 Created response code and groupSetting object in the response body.

Example

Request

POST https://graph.microsoft.com/v1.0/groupSettings
Content-type: application/json
Content-length: 215

{
  "displayName": "displayName-value",
  "templateId": "templateId-value",
  "values": [
    {
      "name": "name-value",
      "value": "value-value"
    }
  ]
}

In the request body, supply a JSON representation of groupSetting object.

Response

Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-type: application/json
Content-length: 238

{
  "displayName": "displayName-value",
  "templateId": "templateId-value",
  "values": [
    {
      "name": "name-value",
      "value": "value-value"
    }
  ],
  "id": "id-value"
}

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var values = new SettingValue
{
	Name = "name-value",
	Value = "value-value",
};

var valuesList = new List<SettingValue>();
valuesList.Add( values );

var groupSetting = new GroupSetting
{
	DisplayName = "displayName-value",
	TemplateId = "templateId-value",
	Values = valuesList,
};

await graphClient.GroupSettings
	.Request()
	.AddAsync(groupSetting);

const options = {
	authProvider,
};

const client = Client.init(options);

const groupSetting = {
  displayName: "displayName-value",
  templateId: "templateId-value",
  values: [
    {
      name: "name-value",
      value: "value-value"
    }
  ]
};

let res = await client.api('/groupSettings')
	.post({groupSetting : groupSetting});

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.