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 |
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.
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.
DELETE https://graph.microsoft.com/v1.0/groupSettings/{id}
Response
HTTP/1.1 204 No Content