フィードバック 編集

historyDefinitions を作成する

  • [アーティクル]

名前空間: microsoft.graph

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

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) AccessReview.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。
アプリケーション AccessReview.ReadWrite.All

サインインしているユーザーは、アクセス レビューを読み取ってデータを取得できるようにするディレクトリ ロールに存在する必要もあります。 詳細については、 アクセス レビューのロールとアクセス許可の要件を参照してください。

HTTP 要求

POST /identityGovernance/accessReviews/historyDefinitions

要求ヘッダー

名前 説明
Authorization ベアラー {token}。必須。
Content-Type application/json. Required.

要求本文

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

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

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

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

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

クエリ プロパティには、次の形式を使用します。

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

{object}値は、accessReviewScheduleDefinition で構成できるリソースの 1 つです。 たとえば、次の例には、個々のグループに対するすべての accessReviewScheduleDefinition レビュー結果が含まれます (また、ゲスト ユーザーを含むすべての Microsoft 365 グループに対する定義は除外されます)。

/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')

サポートされている値の詳細については、「 accessReviewScheduleDefinition で$filterクエリ パラメーターを使用する」を参照してください。

応答

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

例

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

要求

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"
  ],
  "scheduleSettings": {
      "reportRange": "P1M",
      "recurrence": {
          "pattern": {
              "type": "monthly",
              "interval": 1
          },
          "range": {
              "type": "noEnd",
              "startDate": "2018-08-03T21:02:30.667Z",
              "count": 0
          }
        }
  },
  "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",
    "scheduleSettings": {
        "reportRange": "P1M",
        "recurrence": {
            "pattern": {
                "type": "monthly",
                "interval": 1
            },
            "range": {
                "type": "noEnd",
                "startDate": "2018-08-03T21:02:30.667Z",
                "count": 0
            }
        }
    },
    "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
        }
    ]
}