directoryRole 资源类型
命名空间:microsoft.graph
注意
Microsoft建议使用统一的 RBAC API 而不是此 API。 统一的 RBAC API 提供更多的功能和灵活性。 有关详细信息,请参阅 unifiedRoleDefinition 资源类型。
表示Microsoft Entra目录角色。 Microsoft Entra目录角色也称为管理员角色。 有关目录 (管理员) 角色的详细信息,请参阅分配Microsoft Entra管理员角色。 使用 Microsoft Graph,可以将用户分配给目录角色,使其具有目标角色的权限。 要读取目录角色或更新其成员,首先必须在租户中将其激活。 默认情况下,仅激活公司管理员目录角色。 若要激活其他可用的目录角色,请发送具有此目录角色所基于的 directoryRoleTemplate ID 的 POST 请求。 列出目录角色模板,以获取其他所有可用目录角色。 继承自 directoryObject。
该资源支持:
方法
方法 | 返回类型 | 说明 |
---|---|---|
获取目录角色 | directoryRole | 读取 directoryRol 对象的属性和关系。 |
列出目录角色 | directoryRole 集合 | 列出租户中激活的目录角色。 |
添加成员 | directoryObject | 通过发布到成员导航属性将用户添加到目录角色。 |
列出成员 | directoryObject 集合 | 从成员导航属性获取该目录角色成员的用户。 |
删除成员 | directoryObject | 删除目录角色中的用户。 |
激活目录角色 | directoryRole | 激活目录角色。 |
列出作用域成员 | scopedRoleMembership 集合 | 通过 scopedRoleMembership 资源集合列出其作用域为 管理单元 的此目录角色成员。 |
获取增量 | directoryRole 集合 | 获取目录角色的增量更改。 |
属性
属性 | 类型 | 说明 |
---|---|---|
说明 | String | 目录角色说明。 只读。 支持 $filter (eq )、$search 、$select 。 |
displayName | String | 目录角色的显示名称。 只读。 支持 $filter (eq )、$search 、$select 。 |
id | 字符串 | 目录角色唯一标识符。 继承自 directoryObject。 密钥,不可为 NULL,只读。 支持 $filter (eq )、$select 。 |
roleTemplateId | String | 此角色所基于的 directoryRoleTemplate 的 id。 使用 POST 操作在租户中激活目录角色时,必须指定其属性。 激活目录角色后,其属性为只读。 支持 $filter (eq )、$select 。 |
关系
关系 | 类型 | 说明 |
---|---|---|
成员 | directoryObject collection | 是此目录角色成员的用户。 HTTP 方法:GET、POST、DELETE。 只读。 可为 NULL。 支持 $expand 。 |
scopedMembers | scopedRoleMembership 集合 | 此目录角色的成员,其作用域为 管理单元。 只读。 可为 Null。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"description": "string",
"displayName": "string",
"id": "string (identifier)",
"roleTemplateId": "string"
}