更新 customSecurityAttributeDefinition

命名空间:microsoft.graph

更新 customSecurityAttributeDefinition 对象的属性。

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

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

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

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

重要

在具有工作或学校帐户的委托方案中,必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 属性定义管理员 是此操作唯一支持的特权角色。

默认情况下, 全局管理员 和其他管理员角色无权读取、定义或分配自定义安全属性。

HTTP 请求

PATCH /directory/customSecurityAttributeDefinitions/{customSecurityAttributeDefinitionId}

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json. 必需。
OData-Version 4.01. 仅当更新自定义安全属性的预定义值时才需要。

请求正文

在请求正文中, 提供要更新的属性的值。 请求正文中未包含的现有属性会保留其以前的值,或者根据对其他属性值的更改重新计算。

下表指定可更新的属性。

属性 类型 说明
说明 String 自定义安全属性的说明。 最多可包含 128 个字符,并且包含 Unicode 字符。 可选。
status String 指定自定义安全属性是活动还是停用。 可接受的值为 AvailableDeprecated。 可选。
usePreDefinedValuesOnly 布尔值 指示是否只能将预定义值分配给自定义安全属性。 如果设置为 false,则允许自由格式值。 可以从 更改为 truefalse,但不能从 false 更改为 true。 如果 type 设置为 Boolean,则 usePreDefinedValuesOnly 不能设置为 true。 可选。

响应

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

示例

示例 1:更新自定义安全属性

以下示例更新自定义安全属性定义的说明。

  • 属性集:Engineering
  • 属性:ProjectDate

请求

以下示例显示了一个请求。

PATCH https://graph.microsoft.com/v1.0/directory/customSecurityAttributeDefinitions/Engineering_ProjectDate
Content-Type: application/json

{
  "description": "Target completion date (YYYY/MM/DD)",
}

响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content

示例 2:更新自定义安全属性的预定义值

以下示例更新现有预定义值的状态,并为自定义安全属性定义添加新的预定义值。

  • 属性集:Engineering
  • 属性:Project
  • 属性数据类型:字符串集合
  • 更新预定义值: Baker
  • 新的预定义值: Skagit

注意

对于此请求,必须添加 OData-Version 标头并为其分配值 4.01

请求

以下示例显示了一个请求。

PATCH https://graph.microsoft.com/v1.0/directory/customSecurityAttributeDefinitions/Engineering_Project
Content-Type: application/json
OData-Version: 4.01

{
    "allowedValues@delta": [
        {
            "id": "Baker",
            "isActive": false
        },
        {
            "id": "Skagit",
            "isActive": true
        }
    ]
}

响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content

示例 3:停用自定义安全属性

以下示例停用自定义安全属性定义。

  • 属性集:Engineering
  • 属性:Project

请求

以下示例显示了一个请求。

PATCH https://graph.microsoft.com/v1.0/directory/customSecurityAttributeDefinitions/Engineering_Project
Content-Type: application/json

{
  "status": "Deprecated"
}

响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content