列出 customSecurityAttributeDefinitions

命名空间:microsoft.graph

获取 customSecurityAttributeDefinition 对象及其属性的列表。

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

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

权限

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

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

还必须为已登录用户分配以下 目录角色之一:

  • 属性定义读取器
  • 属性分配管理员
  • 属性定义管理员

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

HTTP 请求

GET /directory/customSecurityAttributeDefinitions

可选的查询参数

此方法支持 $select$top$expand$filter (eq) OData 查询参数来帮助自定义响应。 若要了解一般信息,请参阅 OData 查询参数

默认情况下, allowedValues 导航属性不会返回或展开,必须在查询中 $expand 指定。 例如,/directory/customSecurityAttributeDefinitions?$expand=allowedValues

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法在响应正文中返回响应 200 OK 代码和 customSecurityAttributeDefinition 对象的集合。

示例

示例 1:获取所有自定义安全属性

以下示例获取租户中的所有自定义安全属性定义。

请求

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

GET https://graph.microsoft.com/v1.0/directory/customSecurityAttributeDefinitions

响应

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

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directory/customSecurityAttributeDefinitions",
    "value": [
        {
            "attributeSet": "Engineering",
            "description": "Active projects for user",
            "id": "Engineering_Project",
            "isCollection": true,
            "isSearchable": true,
            "name": "Project",
            "status": "Available",
            "type": "String",
            "usePreDefinedValuesOnly": true
        },
        {
            "attributeSet": "Engineering",
            "description": "Target completion date",
            "id": "Engineering_ProjectDate",
            "isCollection": false,
            "isSearchable": true,
            "name": "ProjectDate",
            "status": "Available",
            "type": "String",
            "usePreDefinedValuesOnly": false
        },
        {
            "attributeSet": "Operations",
            "description": "Target completion date",
            "id": "Operations_Level",
            "isCollection": false,
            "isSearchable": true,
            "name": "Deployment level",
            "status": "Available",
            "type": "String",
            "usePreDefinedValuesOnly": true
        }
    ]
}

示例 2:基于名称筛选自定义安全属性

以下示例检索名为 Project 且处于活动状态的自定义安全属性定义。

请求

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

GET https://graph.microsoft.com/v1.0/directory/customSecurityAttributeDefinitions?$filter=name+eq+'Project'%20and%20status+eq+'Available'

响应

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

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directory/customSecurityAttributeDefinitions",
    "value": [
        {
            "attributeSet": "Engineering",
            "description": "Active projects for user",
            "id": "Engineering_Project",
            "isCollection": true,
            "isSearchable": true,
            "name": "Project",
            "status": "Available",
            "type": "String",
            "usePreDefinedValuesOnly": true
        },
        {
            "attributeSet": "Operations",
            "description": "Approved projects",
            "id": "Operations_Project",
            "isCollection": true,
            "isSearchable": true,
            "name": "Project",
            "status": "Available",
            "type": "String",
            "usePreDefinedValuesOnly": true
        }
    ]
}

示例 3:基于属性集筛选自定义安全属性

以下示例检索属性集中的、处于活动状态且类型为 Engineering String 的自定义安全属性定义。

请求

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

GET https://graph.microsoft.com/v1.0/directory/customSecurityAttributeDefinitions?$filter=attributeSet+eq+'Engineering'%20and%20status+eq+'Available'%20and%20type+eq+'String'

响应

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

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directory/customSecurityAttributeDefinitions",
    "value": [
        {
            "attributeSet": "Engineering",
            "description": "Active projects for user",
            "id": "Engineering_Project",
            "isCollection": true,
            "isSearchable": true,
            "name": "Project",
            "status": "Available",
            "type": "String",
            "usePreDefinedValuesOnly": true
        },
        {
            "attributeSet": "Engineering",
            "description": "Target completion date (YYYY/MM/DD)",
            "id": "Engineering_ProjectDate",
            "isCollection": false,
            "isSearchable": true,
            "name": "ProjectDate",
            "status": "Available",
            "type": "String",
            "usePreDefinedValuesOnly": false
        }
    ]
}