创建 assignmentScheduleRequest

命名空间:microsoft.graph

重要

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

创建新的 privilegedAccessGroupAssignmentScheduleRequest 对象。

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

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

权限

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

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

重要

在具有工作或学校帐户的委托方案中,登录用户必须是组的所有者或成员,或者分配有受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 此操作支持以下最低特权角色。

  • 对于可分配角色的组: 特权角色管理员
  • 对于不可分配角色的组:目录编写者组管理员标识治理管理员用户管理员

调用用户的角色分配应限定在目录级别。

具有管理组 (权限的其他角色(例如,365 个组的非角色可分配Microsoft的 Exchange 管理员)) 和在管理单元级别分配的管理员可以通过组 API 管理组,并通过组 API 替代 Microsoft Entra PIM 中所做的更改。

HTTP 请求

POST /identityGovernance/privilegedAccess/group/assignmentScheduleRequests

请求标头

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

请求正文

在请求正文中,提供 privilegedAccessGroupAssignmentScheduleRequest 对象的 JSON 表示形式。

创建 privilegedAccessGroupAssignmentScheduleRequest 时,可以指定以下属性。

属性 类型 说明
accessId privilegedAccessGroupRelationships 与组的成员身份或所有权分配关系的标识符。 可能的值为: ownermember。 必填。
action String 表示对组成员身份或所有权分配请求执行的操作的类型。 可取值包括:adminAssignadminUpdateadminRemoveselfActivateselfDeactivateadminExtendadminRenew
  • adminAssign:供管理员将组成员身份或所有权分配给主体。
  • adminRemove:供管理员从组成员身份或所有权中删除主体。
  • adminUpdate:供管理员更改现有组成员身份或所有权分配。
  • adminExtend:供管理员延长即将到期的工作分配。
  • adminRenew:供管理员续订过期的分配。
  • selfActivate:供主体激活其分配。
  • selfDeactivate:使主体停用其活动分配。
必填。
customData String 用于定义请求的任何自定义数据的自由文本字段。 可选。
groupId String 组的标识符,表示通过组的 PIM 分配的成员身份或所有权分配的范围。 必填。
理由 String 用户和管理员在创建 privilegedAccessGroupAssignmentScheduleRequest 对象时提供的消息。 可选。
principalId String 通过组的 PIM 授予其成员身份或所有权分配的主体的标识符。 必填。
scheduleInfo requestSchedule 组 PIM 的组成员身份或所有权分配的时间段。 目前不支持定期计划。 必填。
ticketInfo ticketInfo 链接到组成员身份或所有权分配请求的票证详细信息,包括票证编号和票证系统的详细信息。 可选。

响应

如果成功,此方法在 201 Created 响应正文中返回响应代码和 privilegedAccessGroupAssignmentScheduleRequest 对象。

示例

示例 1:创建分配计划请求

以下请求创建分配计划请求,以将主体活动成员身份分配给指定的组。 活动成员资格将在两小时后过期。

请求

POST https://graph.microsoft.com/beta/identityGovernance/privilegedAccess/group/assignmentScheduleRequests
Content-Type: application/json

{
  "accessId": "member", 
  "principalId": "3cce9d87-3986-4f19-8335-7ed075408ca2", 
  "groupId": "68e55cce-cf7e-4a2d-9046-3e4e75c4bfa7", 
  "action": "adminAssign", 
  "scheduleInfo": { 
      "startDateTime": "2022-12-08T07:43:00.000Z", 
      "expiration": { 
          "type": "afterDuration", 
          "duration": "PT2H" 
      } 
  }, 
  "justification": "Assign active member access."
}

响应

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

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "https://graph.microsoft.com/beta/$metadata#identityGovernance/privilegedAccess/group/assignmentScheduleRequests/$entity",
  "id": "34e963f6-150f-cf79-678c-6fcaf978bb49",
  "status": "Provisioned",
  "completedDateTime": "2023-02-07T07:05:55.3404527Z",
  "createdDateTime": "2023-02-07T07:05:53.7895614Z",
  "approvalId": null,
  "customData": null,
  "createdBy": {
      "user": {
          "id": "3cce9d87-3986-4f19-8335-7ed075408ca2"
      }
  },
  "action": "adminAssign",
  "isValidationOnly": false,
  "justification": "Assign active member access.",
  "scheduleInfo": {
      "startDateTime": "2023-02-07T07:05:55.3404527Z",
      "expiration": {
        "type": "afterDuration",
         "duration": "PT2H"
      }
  },
  "ticketInfo": {
      "ticketNumber": null,
      "ticketSystem": null
  },
  "accessId": "member", 
  "principalId": "3cce9d87-3986-4f19-8335-7ed075408ca2", 
  "groupId": "68e55cce-cf7e-4a2d-9046-3e4e75c4bfa7",
  "targetScheduleId": "2b5ed229-4072-478d-9504-a047ebd4b07d_member_6aacaee8-4089-4048-9510-3119367fc943"
}

示例 2:用户激活其 PIM 的合格分配组

在以下请求中, 由 principalId3cce9d87-3986-4f19-8335-7ed075408ca2 标识的用户将激活其 合格成员身份 到由 groupId2b5ed229-4072-478d-9504-a047ebd4b07d 标识的 PIM 管理的组。

请求

POST https://graph.microsoft.com/beta/identityGovernance/privilegedAccess/group/assignmentScheduleRequests
Content-Type: application/json

{
  "accessId": "member", 
  "principalId": "3cce9d87-3986-4f19-8335-7ed075408ca2", 
  "groupId": "2b5ed229-4072-478d-9504-a047ebd4b07d", 
  "action": "selfActivate", 
  "scheduleInfo": { 
      "startDateTime": "2023-02-08T07:43:00.000Z", 
      "expiration": { 
          "type": "afterDuration", 
          "duration": "PT2H" 
      } 
  }, 
  "justification": "Activate assignment."
}

响应

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

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "https://graph.microsoft.com/beta/$metadata#identityGovernance/privilegedAccess/group/assignmentScheduleRequests/$entity",
  "id": "6aacaee8-4089-4048-9510-3119367fc943",
  "status": "Provisioned",
  "completedDateTime": "2023-02-07T07:05:55.3404527Z",
  "createdDateTime": "2023-02-07T07:05:53.7895614Z",
  "approvalId": null,
  "customData": null,
  "createdBy": {
      "user": {
          "id": "3cce9d87-3986-4f19-8335-7ed075408ca2"
      }
  },
  "action": "selfActivate",
  "isValidationOnly": false,
  "justification": "Activate assignment.",
  "scheduleInfo": {
      "startDateTime": "2023-02-07T07:05:55.3404527Z",
      "expiration": {
        "type": "afterDuration",
         "duration": "PT2H"
      }
  },
  "ticketInfo": {
      "ticketNumber": null,
      "ticketSystem": null
  },
  "accessId": "member", 
  "principalId": "3cce9d87-3986-4f19-8335-7ed075408ca2", 
  "groupId": "2b5ed229-4072-478d-9504-a047ebd4b07d",
  "targetScheduleId": "2b5ed229-4072-478d-9504-a047ebd4b07d_member_6aacaee8-4089-4048-9510-3119367fc943"
}