Delete a group setting

Namespace: microsoft.graph

Delete a tenant-level or group-specific groupSetting object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

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

For all settings except the Consent Policy Settings object

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Directory.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	Directory.ReadWrite.All

For the Consent Policy Settings object

The following permissions are required to update the "Consent Policy Settings" directorySetting object.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Policy.ReadWrite.Authorization
Delegated (personal Microsoft account)	Not supported.
Application	Policy.ReadWrite.Authorization

For delegated scenarios, the calling user needs at least one of the following Microsoft Entra roles.

Microsoft Entra role	Allowed privileges
Microsoft Entra Joined Device Local Administrator Directory Readers Global Reader	Read basic properties on setting templates and settings
Groups Administrator Directory Writers	Manage all group settings
Authentication Policy Administrator	Update Password Rule Settings
User Administrator	Read basic properties on setting templates and settings Update settings

HTTP request

Delete a tenant-wide setting.

DELETE /groupSettings/{groupSettingId}

Delete a group-specific setting.

DELETE /groups/{groupId}/settings/{groupSettingId}

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json

Request body

Don't supply a request body for this method.

Response

If successful, this method returns 204 No Content response code. It doesn't return anything in the response body.

Example

Request

In this example, you delete the tenant-level group setting object.

HTTP

DELETE https://graph.microsoft.com/v1.0/groupSettings/{id}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.GroupSettings["{groupSetting-id}"].DeleteAsync();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc group-settings delete --group-setting-id {groupSetting-id}

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



graphClient.GroupSettings().ByGroupSettingId("groupSetting-id").Delete(context.Background(), nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.groupSettings().byGroupSettingId("{groupSetting-id}").delete();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/groupSettings/{id}')
	.delete();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->groupSettings()->byGroupSettingId('groupSetting-id')->delete()->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


await graph_client.group_settings.by_group_setting_id('groupSetting-id').delete()

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

HTTP/1.1 204 No Content