命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
在 PIM 中, 表示向主体分配活动角色的请求。 角色分配可以永久处于活动状态,无论是否具有到期日期,或者在激活符合条件的分配后暂时处于活动状态。 继承自 请求。
有关可以通过 unifiedRoleAssignmentScheduleRequest 资源类型定义的 PIM 方案的详细信息,请参阅 通过特权标识管理 (PIM) API 进行角色管理概述。
方法
| 方法 | 返回类型 | Description | 
|---|---|---|
| List | unifiedRoleAssignmentScheduleRequest 集合 | 检索通过 unifiedRoleAssignmentScheduleRequest 对象发出的活动角色分配请求。 | 
| 创建 | unifiedRoleAssignmentScheduleRequest | 创建主动和持久角色分配请求,或者激活、停用、延长或续订符合条件的角色分配。 | 
| Get | unifiedRoleAssignmentScheduleRequest | 检索通过 unifiedRoleAssignmentScheduleRequest 对象发出的活动角色分配请求。 | 
| Cancel | None | 取消对活动角色分配的请求。 | 
| 按当前用户筛选 | unifiedRoleAssignmentScheduleRequest 集合 | 检索特定主体的活动角色分配请求。 | 
属性
| 属性 | 类型 | 说明 | 
|---|---|---|
| action | String | 表示对角色分配请求的操作类型。 可取值包括:adminAssign、adminUpdate、adminRemove、selfActivate、selfDeactivate、adminExtend、adminRenew、selfExtend、selfRenew、unknownFutureValue。 
  | 
| approvalId | String | 请求审批的标识符。 继承自 请求。 | 
| appScopeId | String | 分配范围限定为应用时,特定于应用的范围的标识符。 分配的范围确定已向其授予主体访问权限的资源集。 应用范围是仅此应用程序定义和理解的范围。 用于 / 租户范围的应用范围。 使用 directoryScopeId 将范围限制为特定的目录对象,例如管理单元。 支持$filter对值) eq (null 、 ne和 。 | 
| completedDateTime | DateTimeOffset | 请求完成日期时间。 继承自 请求。 | 
| createdBy | identitySet | 创建此请求的主体。 继承自 请求。 此为只读属性。 支持$filter对值) eq (null 、 ne和 。 | 
| createdDateTime | DateTimeOffset | 请求创建日期时间。 继承自 请求。 此为只读属性。 | 
| customData | String | 用于定义请求的任何自定义数据的自由文本字段。 未使用。 继承自 请求。 | 
| directoryScopeId | String | 表示分配范围的目录对象的标识符。 分配的范围确定已向其授予主体访问权限的资源集。 目录范围是存储在目录中的共享范围,可由多个应用程序理解。 用于 / 租户范围。 使用 appScopeId 将范围限制为仅应用程序。 支持$filter对值) eq (null 、 ne和 。 | 
| id | String | 
              unifiedRoleAssignmentScheduleRequest 对象的唯一标识符。 键,不可为 null,只读。 继承自 entity。 支持 $filter(eq、ne)。 | 
| isValidationOnly | 布尔值 | 确定调用是验证还是实际调用。 仅当想要在实际提交请求之前检查激活是否受其他规则(如 MFA)的约束时,才设置此属性。 | 
| 理由 | String | 用户和管理员在创建 unifiedRoleAssignmentScheduleRequest 对象时提供的消息。 | 
| principalId | String | 已授予分配的主体的标识符。 可以是用户、可分配角色的组或服务主体。 支持 $filter(eq、ne)。 | 
| roleDefinitionId | String | 要分配给主体的 unifiedRoleDefinition 对象的标识符。 支持 $filter(eq、ne)。 | 
| scheduleInfo | requestSchedule | 角色分配的时间段。 目前不支持定期计划。 | 
| status | String | 角色分配请求的状态。 继承自 请求。 此为只读属性。 支持 $filter(eq、ne)。 | 
| targetScheduleId | String | 链接到分配请求的计划对象的标识符。 支持 $filter(eq、ne)。 | 
| ticketInfo | ticketInfo | 链接到角色分配请求的票证详细信息,包括票证编号和票证系统的详细信息。 | 
关系
| 关系 | 类型 | 说明 | 
|---|---|---|
| activatedUsing | unifiedRoleEligibilitySchedule | 如果请求来自符合条件的管理员以激活角色,则此参数将显示该激活的相关合格分配。 否则为 null。 支持 $expand 并 $select 嵌套在 中 $expand。 | 
| appScope | appScope | 当分配范围限定为应用时,具有特定于应用的范围的详细信息的只读属性。 可为 NULL。 支持 $expand。 | 
| directoryScope | directoryObject | 作为分配范围的目录对象。 只读。 支持 $expand。 | 
| 主要 | directoryObject | 通过请求获取角色分配的主体。 仅针对 ID 支持$expand和$select嵌套$expand。 | 
| roleDefinition | unifiedRoleDefinition | 通过 roleDefinitionId 属性引用的 unifiedRoleDefinition 对象的详细信息。 支持 $expand 并 $select 嵌套在 中 $expand。 | 
| targetSchedule | unifiedRoleAssignmentSchedule | 通过 targetScheduleId 属性引用的合格角色分配的计划。 支持 $expand 并 $select 嵌套在 中 $expand。 | 
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
  "@odata.type": "#microsoft.graph.unifiedRoleAssignmentScheduleRequest",
  "id": "String (identifier)",
  "status": "String",
  "completedDateTime": "String (timestamp)",
  "createdDateTime": "String (timestamp)",
  "approvalId": "String",
  "customData": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "action": "String",
  "principalId": "String",
  "roleDefinitionId": "String",
  "directoryScopeId": "String",
  "appScopeId": "String",
  "isValidationOnly": "Boolean",
  "targetScheduleId": "String",
  "justification": "String",
  "scheduleInfo": {
    "@odata.type": "microsoft.graph.requestSchedule"
  },
  "ticketInfo": {
    "@odata.type": "microsoft.graph.ticketInfo"
  }
}