次の方法で共有

historyDefinitions を作成する

  • [アーティクル]

名前空間: microsoft.graph

新しい accessReviewHistoryDefinition オブジェクトを 作成します。

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

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

アクセス許可

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

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

重要

職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 この操作では、次の最小特権ロールがサポートされています。

  • グループまたはアプリのアクセス レビューを記述するには: ユーザー管理者、 ID ガバナンス管理者
  • Microsoft Entra ロールのアクセス レビューを記述するには: ID ガバナンス管理者、特権ロール管理者

HTTP 要求

POST /identityGovernance/accessReviews/historyDefinitions

要求ヘッダー

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

要求本文

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

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

プロパティ 型 説明
displayName String アクセス レビュー履歴データ収集の名前。 必須です。
reviewHistoryPeriodStartDateTime DateTimeOffset タイムスタンプ。 この日付以降のレビューは、フェッチされた履歴データに含まれます。 scheduleSettings が定義されていない場合にのみ必要です。
reviewHistoryPeriodEndDateTime DateTimeOffset タイムスタンプ。 この日付以降のレビューは、フェッチされた履歴データに含まれます。 scheduleSettings が定義されていない場合にのみ必要です。
scopes accessReviewQueryScope コレクション フェッチされた履歴データに含まれるレビューをフィルター処理するために使用されます。 スコープがこの指定されたスコープと一致するレビューをフェッチします。 必須です。
詳細については、「 accessReviewHistoryDefinition でサポートされているスコープ クエリ」を参照してください。
scheduleSettings accessReviewHistoryScheduleSettings まだサポートされていません。 定期的なアクセス レビュー履歴の定義シリーズの設定。 reviewHistoryPeriodStartDateTime または reviewHistoryPeriodEndDateTime が定義されていない場合にのみ必要です。

accessReviewHistoryDefinition でサポートされているスコープ クエリ

accessReviewHistoryDefinition の scopes プロパティは、accessReviewQueryScope に基づいており、クエリ プロパティ内のさまざまなリソースを構成できるリソースです。 これらのリソースは、履歴定義のスコープを表し、履歴定義の accessReviewHistoryInstances の作成時に生成されるダウンロード可能な CSV ファイルに含まれるレビュー履歴データの種類を指定します。

contains 演算子を使用した $filter クエリ パラメーターは、accessReviewScheduleDefinition の scope プロパティでサポートされています。 要求には次の形式を使用します。

/identityGovernance/accessReviews/definitions?$filter=contains(scope/microsoft.graph.accessReviewQueryScope/query, '{object}')

{object}には、次のいずれかの値を指定できます。

値 説明
/groups 個々のグループのすべての accessReviewScheduleDefinition を一覧表示します (ゲストを含むすべての Microsoft 365 グループを対象とする定義は除外されます)。
/groups/{group id} 特定のグループのすべての accessReviewScheduleDefinition を一覧表示します (ゲストを含むすべての Microsoft 365 グループを対象とする定義は除外されます)。
./members ゲストを含むすべての Microsoft 365 グループを対象にしたすべての accessReviewScheduleDefinition を一覧表示します。
accessPackageAssignments アクセス パッケージのすべての accessReviewScheduleDefinition を一覧表示します。
roleAssignmentScheduleInstances 特権ロールに割り当てられているプリンシパルのすべての accessReviewScheduleDefinition を一覧表示します。

$filter クエリ パラメーターは、accessReviewInactiveUserQueryScope または principalResourceMembershipScope ではサポートされていません。

応答

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

例

次の例は、2021 年 1 月 1 日から 2021 年 4 月 5 日の終了日までの間に実行される、アクセス パッケージとグループのアクセス レビューを対象にしたアクセス レビュー履歴定義を作成する方法を示しています。

要求

POST https://graph.microsoft.com/v1.0/identityGovernance/accessReviews/historyDefinitions
Content-Type: application/json

{
  "displayName": "Last quarter's group reviews April 2021",
  "decisions": [
    "approve",
    "deny",
    "dontKnow",
    "notReviewed",
    "notNotified"
  ],
  "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z",
  "reviewHistoryPeriodEndDateTime": "2021-04-30T23:59:59Z",
  "scopes": [
    {
      "@odata.type": "#microsoft.graph.accessReviewQueryScope",
      "queryType": "MicrosoftGraph",     
      "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'accessPackageAssignments')",
      "queryRoot": null
    },  
    {
      "@odata.type": "#microsoft.graph.accessReviewQueryScope",
      "queryType": "MicrosoftGraph",     
      "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')",
      "queryRoot": null
    }
  ]
}

応答

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
    "@odata.type": "#microsoft.graph.accessReviewHistoryDefinition",
    "id": "b2cb022f-b7e1-40f3-9854-c65a40861c38",
    "displayName": "Last quarter's group reviews April 2021",
    "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z",
    "reviewHistoryPeriodEndDateTime": "2021-04-30T23:59:59Z",
    "decisions": [
        "approve",
        "deny",
        "dontKnow",
        "notReviewed",
        "notNotified"
    ],
    "status": "requested",
    "createdDateTime": "2021-04-14T00:22:48.9392594Z",
    "createdBy": {
        "id": "957f1027-c0ee-460d-9269-b8444459e0fe",
        "displayName": "MOD Administrator",
        "userPrincipalName": "admin@contoso.com"
    },
    "scopes": [
        {
            "@odata.type": "#microsoft.graph.accessReviewQueryScope",
            "queryType": "MicrosoftGraph",
            "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'accessPackageAssignments')",
            "queryRoot": null
        },
        {
            "@odata.type": "#microsoft.graph.accessReviewQueryScope",
            "queryType": "MicrosoftGraph",
            "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')",
            "queryRoot": null
        }
    ]
}