appRole 资源类型

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

表示可由 (请求并授予) 客户端应用程序的应用程序角色,或者可用于将应用程序分配给具有指定角色的用户或组的应用程序角色。

若要添加、更新或删除应用程序的应用角色, 请更新 应用或服务的应用程序。 应用程序实体上的应用角色将在使用应用程序的所有租户中可用。 若要定义仅适用于租户的应用角色 (例如,在多租户应用程序) 实例中表示自定义角色的应用角色,还可以 更新应用的服务主体 ,以将应用角色添加或更新到 appRoles 集合。

使用 appRoleAssignments,可将应用角色分配给用户、组或其他应用程序的服务主体。

属性

属性 类型 说明
allowedMemberTypes 字符串集合 指定此应用角色是否可通过将 设置为) 分配给 (用户和组,也可以通过将 设置为 ["User"] 来分配给其他应用程序的 (["Application"],或者通过将 设置为) 来 ["User", "Application"] 同时 (。 支持分配给其他应用程序的服务主体的应用角色也称为 应用程序权限。 “Application”值仅支持在应用程序实体上定义的 应用 角色。
说明 String 应用角色的说明。 当分配应用角色时,如果应用角色充当应用程序权限,则会在许可体验期间显示此信息。
displayName String 应用角色分配和同意体验中显示的权限的显示名称。
id Guid appRoles 集合中的唯一角色标识符。 创建新的应用角色时,必须指定新的 GUID 标识符。
isEnabled Boolean 创建或更新应用角色时,必须将其设置为 true (这是默认) 。 若要删除角色,必须先将其设置为 false。 此时,在后续调用中,可能会删除此角色。
起源 String 指定是在应用程序对象还是 servicePrincipal 实体上定义应用角色。 不得包含在任何 POST 或 PATCH 请求中。 此为只读属性。
value String 指定要包含在声明中的 roles ID 令牌中的值,以及对分配的用户或服务主体进行身份验证的访问令牌。 长度不能超过 120 个字符。 允许的字符是 :{#$!.-,+/*)(:'&%;<@?[>]^_|~}`=+、 和 范围内的0-9字符、 A-Z 和 。a-z 不允许使用任何其他字符,包括空格字符。 不能以 .开头。

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

{
  "allowedMemberTypes": ["String"],
  "description": "String",
  "displayName": "String",
  "id": "Guid",
  "isEnabled": true,
  "origin": "String",
  "value": "String"
}