创建已弃用的 accessReview ()

命名空间:microsoft.graph

重要

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

备注

访问评审 API 已弃用,将在 2023 年 5 月 19 日停止返回数据。 请使用 访问评审

在 Azure AD 访问评审 功能中,创建新的 accessReview 对象。

发出此请求之前,调用方必须以前 检索业务流模板列表,才能在请求中包含 businessFlowTemplateId 的值。

发出此请求后,调用方应 创建 programControl,以将访问评审链接到程序。

权限

要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限

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

调用方还应具有 ProgramControl.ReadWrite.All 权限,以便在创建访问评审后,调用方可以创建 programControl。 此外,已登录的用户还必须具有允许其创建访问评审的目录角色。 有关详细信息,请参阅 访问评审的角色和权限要求。

HTTP 请求

POST /accessReviews

请求标头

名称 说明
Authorization 持有者 {token}。 必需。
Content-type application/json. Required.

请求正文

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

下表显示了创建 accessReview 时所需的属性。

属性 类型 说明
displayName String 访问评审名称。
startDateTime DateTimeOffset 计划开始评审时的 DateTime。 这必须是将来的日期。
endDateTime DateTimeOffset 计划结束评审时的 DateTime。 这必须至少比开始日期晚一天。
description String 要向审阅者显示的说明。
businessFlowTemplateId String businessFlowTemplate 获取的业务流模板标识符。
reviewerType String 审阅者与审阅对象的访问权限的关系类型,其中 self之一, delegatedentityOwners
reviewedEntity identity 为其创建访问评审的对象,例如组的成员身份或用户对应用程序的分配。

如果 reviewerType 具有该值 delegated,则调用方还必须包含 审阅者 属性,其中包含一个表示审阅者的 userIdentity 对象集合。

如果应用在没有登录用户的情况下调用此 API,则调用方还必须包括 createdBy 属性,该属性的值是将标识为评审创建者的用户的 userIdentity

此外,调用方可以包括 设置、创建定期评审系列或更改默认审阅行为。 特别是,若要创建定期评审,调用方必须在访问评审设置中包含 accessReviewRecurrenceSettings

响应

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

示例

这是创建一次性 (不定期) 访问评审的示例,明确指定两个用户为审阅者。

请求

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

POST https://graph.microsoft.com/beta/accessReviews
Content-type: application/json

{
    "displayName":"TestReview",
    "startDateTime":"2017-02-10T00:35:53.214Z",
    "endDateTime":"2017-03-12T00:35:53.214Z",
    "reviewedEntity": {
        "id": "99025615-a0b1-47ec-9117-35377b10998b"
    },
    "reviewerType" : "delegated",
    "businessFlowTemplateId": "6e4f3d20-c5c3-407f-9695-8460952bcc68",
    "description":"Sample description",
    "reviewers":
    [
        {
            "id":"f260246a-09b1-4fd5-8d18-daed736071ec"
        },
        {
            "id":"5a4e184c-4ee5-4883-96e9-b371f8da88e3"
        }
    ],
    "settings":
    {
        "mailNotificationsEnabled": true,
        "remindersEnabled": true,
        "justificationRequiredOnApproval":true,
        "autoReviewEnabled":false,
        "activityDurationInDays":30,
        "autoApplyReviewResultsEnabled":false,
        "accessRecommendationsEnabled":false,
        "recurrenceSettings":{
            "recurrenceType":"onetime",
            "recurrenceEndType":"endBy",
            "durationInDays":0,
            "recurrenceCount":0
        },
        "autoReviewSettings":{
            "notReviewedResult":"Deny"
        }
    }
}

响应

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

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

{
    "id": "006111db-0810-4494-a6df-904d368bd81b",
    "displayName": "TestReview",
    "startDateTime": "2017-02-10T00:35:53.214Z",
    "endDateTime": "2017-03-12T00:35:53.214Z",
    "status": "Initializing",
    "businessFlowTemplateId": "6e4f3d20-c5c3-407f-9695-8460952bcc68",
    "reviewerType": "delegated",
    "description": "Sample description"
}