accessReview の作成 (非推奨)

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

注意

このバージョンのアクセス レビュー API は非推奨となり、2023 年 5 月 19 日にデータの返しを停止します。 アクセス レビュー API を使用してください。

Microsoft Entraアクセス レビュー機能で、新しい accessReview オブジェクトを作成します。

この要求を行う前に、呼び出し元は、要求に含める businessFlowTemplateId の値を持つビジネス フロー テンプレートの一覧を以前に取得しておく必要があります。

この要求を行った後、呼び出し元は programControl を作成して、アクセス レビューをプログラムにリンクする必要があります。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) AccessReview.ReadWrite.Membership AccessReview.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション AccessReview.ReadWrite.Membership 注意事項なし。

呼び出し元には ProgramControl.ReadWrite.All アクセス許可も必要です。そのため、アクセス レビューを作成した後、呼び出し元は programControl を作成できます。 さらに、サインインしているユーザーは、アクセス レビューの作成を許可するディレクトリ ロールにも存在する必要があります。 詳細については、 アクセス レビューのロールとアクセス許可の要件に関するページを参照してください。

HTTP 要求

POST /accessReviews

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-type application/json. 必須です。

要求本文

要求本文で、 accessReview オブジェクトの JSON 表現を指定します。

次の表は、accessReview を作成するときに必要なプロパティを示しています。

プロパティ 説明
displayName String アクセス レビュー名。
startDateTime DateTimeOffset レビューの開始がスケジュールされている DateTime。 これは将来の日付である必要があります。
endDateTime DateTimeOffset レビューが終了するようにスケジュールされている DateTime。 これは、開始日より少なくとも 1 日遅くする必要があります。
説明 String 校閲者に表示する説明。
businessFlowTemplateId String businessFlowTemplate から取得されたビジネス フロー テンプレート識別子。
reviewerType String レビュー対象オブジェクト (、、または entityOwnersのいずれか) のアクセス権に対するレビュー担当者のリレーションシップのselfdelegated種類。
reviewedEntity identity グループのメンバーシップやアプリケーションへのユーザーの割り当てなど、アクセス レビューが作成されるオブジェクト。

reviewerType の値delegatedが である場合、呼び出し元には、レビュー担当者を表す userIdentity オブジェクトのコレクションを含むレビュー担当者プロパティも含める必要があります。

アプリがサインインユーザーなしでこの API を呼び出している場合、呼び出し元には、レビューの作成者として識別されるユーザーの userIdentity である createdBy プロパティも含める必要があります。

さらに、呼び出し元は、定期的なレビューシリーズを作成したり、既定のレビュー動作から変更したりするための 設定を含めることができます。 特に、定期的なレビューを作成するには、呼び出し元がアクセス レビュー設定内に accessReviewRecurrenceSettings を含める必要があります。

応答

成功した場合、このメソッドは 201 Created 応答コードと、応答本文の accessReview オブジェクトを返します。

これは、2 人のユーザーをレビュー担当者として明示的に指定して、1 回限りの (定期的ではない) アクセス レビューを作成する例です。

要求

要求本文で、 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"
}