directoryObject: getAvailableExtensionProperties

命名空间:microsoft.graph

返回在目录中注册的所有目录扩展定义,包括通过多租户应用注册的定义。 以下实体支持扩展属性:

重要

此 API 有一个已知问题,仅处理最多 1,000 个服务主体的租户的结果;否则,它将返回空响应。 请改 用 list extensionProperties (目录扩展) 。

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

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

权限

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

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

重要

对于使用工作或学校帐户的委派访问,必须为登录用户分配受支持的Microsoft Entra角色或授予此操作所需权限的自定义角色。 此操作支持以下内置角色,这些角色仅提供所需的最小特权:

  • 目录作者
  • 云应用程序管理员
  • 应用程序管理员

HTTP 请求

POST /directoryObjects/getAvailableExtensionProperties

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。

请求正文

在请求正文中,提供参数的 JSON 表示形式。

下表显示了可用于此操作的参数。

参数 类型 说明
isSyncedFromOnPremises 布尔值 true 指定仅应返回从本地目录同步的扩展属性; false 指定仅返回未从本地目录同步的扩展属性。 如果省略参数,则返回同步和非同步) (的所有扩展属性。 可选。

响应

如果成功,此操作将在 200 OK 响应正文中返回响应代码和 extensionProperty 集合。

示例

请求

POST https://graph.microsoft.com/v1.0/directoryObjects/getAvailableExtensionProperties

{

}

响应

注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(extensionProperty)",
  "value": [
    {
      "@odata.type": "#microsoft.graph.extensionProperty",
      "id": "d6a8bfec-893d-46e4-88fd-7db5fcc0fa62",
      "deletedDateTime": null,
      "appDisplayName": "SampleApp",
      "name": "extension_4d405aa8baa04fb494d3e0571fd9fd71_skypeId",
      "dataType": "String",
      "isSyncedFromOnPremises": false,
      "targetObjects": [
        "User"
      ]
    }
  ]
}