更新 groupSetting

命名空间:microsoft.graph

更新租户范围的组设置或特定设置的 groupSetting 对象的属性。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

下表显示了对每种受支持的资源类型调用此 API 所需的最低特权权限。 请遵循 最佳做法 来请求最低特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) GroupSettings.ReadWrite.All Directory.ReadWrite.All、Policy.ReadWrite.Authorization
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 GroupSettings.ReadWrite.All Directory.ReadWrite.All、Policy.ReadWrite.Authorization

更新“同意策略设置” 目录Setting 对象需要以下权限。

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) GroupSettings.ReadWrite.All Directory.ReadWrite.All、Policy.ReadWrite.Authorization
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 GroupSettings.ReadWrite.All Directory.ReadWrite.All、Policy.ReadWrite.Authorization

重要

在具有工作或学校帐户的委托方案中,必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 此作支持以下最低特权角色。

  • 读取有关设置模板和设置的基本属性 - Microsoft Entra加入的设备本地管理员、目录读取器、全局读取器
  • 管理所有组/目录设置 - 目录编写器
  • 管理组的全局和本地设置;管理和Group.Unified.GuestGroup.Unified设置 - 组管理员
  • 更新 Password Rule Settings - 身份验证策略管理员
  • 更新设置,读取有关设置模板和设置的基本属性 - 用户管理员

HTTP 请求

更新租户范围的设置。

PATCH /groupSettings/{groupSettingId}

更新组特定的设置。

PATCH /groups/{groupId}/settings/{groupSettingId}

请求标头

名称 说明
Authorization {token}。 必填。
Content-Type application/json

请求正文

在请求正文中,提供应更新的相关字段的值。

属性 类型 说明
settingValue 集合 更新的值集。 必须包括整个收集组。 不能更新单个值集。

响应

如果成功,此方法返回 204 No Content 响应代码。

示例

示例 1:更新租户范围的组设置

在此示例中, 84af2ca5-c274-41bf-86e4-6e374ec4def6 是租户范围的 groupSetting 对象的标识符。

请求

PATCH https://graph.microsoft.com/v1.0/groupSettings/84af2ca5-c274-41bf-86e4-6e374ec4def6
Content-type: application/json

{
    "values": [
        {
            "name": "AllowToAddGuests",
            "value": "false"
        }
    ]
}

响应

HTTP/1.1 204 No Content

示例 2:更新特定组设置

在此示例中, 0167b5af-f3d1-4910-82d2-398747fa381c 是组的标识符,是 fa6df613-159b-4f94-add2-7093f961900b groupSetting 对象的标识符。

请求

PATCH https://graph.microsoft.com/v1.0/groups/0167b5af-f3d1-4910-82d2-398747fa381c/settings/fa6df613-159b-4f94-add2-7093f961900b
Content-type: application/json

{
  "values": [
    {
      "name": "AllowToAddGuests",
      "value": "true"
    }
  ]
}

响应

HTTP/1.1 204 No Content