リスト定義
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
accessReviewScheduleDefinition オブジェクトを取得します。 0 個以上の accessReviewScheduleDefinition オブジェクトのリストが、作成されたアクセス レビュー シリーズごとに、入れ子になったプロパティをすべて含めて返されます。 これには、関連付けられている accessReviewInstance オブジェクトは含まれません。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | AccessReview.Read.All | AccessReview.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | AccessReview.Read.All | AccessReview.ReadWrite.All |
重要
職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 この操作では、次の最小特権ロールがサポートされています。
グループまたはアプリのアクセス レビューを読み取る: アクセス レビューの作成者。 グローバル リーダー、 セキュリティ 閲覧者、 ユーザー管理者、 ID ガバナンス管理者、 セキュリティ管理者
Microsoft Entra ロールのアクセス レビューを読むには:セキュリティ 閲覧者、ID ガバナンス管理者、特権ロール管理者、セキュリティ管理者
HTTP 要求
すべての accessReviewScheduleDefinitions を一覧表示するには:
GET /identityGovernance/accessReviews/definitions
オプションのクエリ パラメーター
このメソッドは、応答をカスタマイズするための $select、$top、$skip、$filter OData クエリ パラメーターをサポートします。 一般的な情報については、「OData クエリ パラメーター」を参照してください。
この API の既定のページ サイズは 100 accessReviewScheduleDefinition オブジェクトです。 効率を向上させ、大きな結果セットによるタイムアウトを回避するには、 $skip と $top クエリ パラメーターを使用して改ページ処理を適用します。 詳細については、アプリで Microsoft Graph データをページングするを参照してください。
$filter クエリ パラメーターを使用する
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 ではサポートされていません。
要求ヘッダー
なし。
要求本文
要求本文を指定しないでください。
応答
成功した場合、このメソッドは 200 OK 応答コードと、応答本文の accessReviewScheduleDefinition オブジェクトの配列を返します。
例
例 1: 最初の 100 個のアクセス レビュー定義を一覧表示する
要求
GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions?$top=100&$skip=0
応答
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/accessReviews/definitions",
"@odata.count": 1,
"value": [
{
"id": "98dcebed-c7f6-46f4-bcf3-4a3fccdb3e2a",
"displayName": "Access Review",
"scope": {
"@odata.type": "#microsoft.graph.accessReviewQueryScope",
"query": "/groups/119cc181-22f0-4e18-8537-264e7524ee0b/transitiveMembers",
"queryType": "MicrosoftGraph"
},
"instanceEnumerationScope": {
"@odata.type": "#microsoft.graph.accessReviewQueryScope",
"query": "/groups/119cc181-22f0-4e18-8537-264e7524ee0b",
"queryType": "MicrosoftGraph"
},
"reviewers": [
{
"query": "./manager",
"queryType": "MicrosoftGraph",
"queryRoot": "decisions"
}
],
"settings": {
"mailNotificationsEnabled": true,
"reminderNotificationsEnabled": true,
"justificationRequiredOnApproval": true,
"defaultDecisionEnabled": false,
"defaultDecision": "None",
"instanceDurationInDays": 0,
"autoApplyDecisionsEnabled": false,
"recommendationsEnabled": true,
"recurrence": {
"pattern": {
"type": "weekly",
"interval": 1,
"month": 0,
"dayOfMonth": 0,
"daysOfWeek": [],
"firstDayOfWeek": "sunday",
"index": "first"
},
"range": {
"type": "numbered",
"numberOfOccurrences": 0,
"recurrenceTimeZone": null,
"startDate": "2020-09-11",
"endDate": "9999-12-31"
}
}
}
}
]
}
例 2: テナント内のすべての Microsoft 365 グループを対象とするすべてのアクセス レビュー定義を取得する
要求
次の例は、テナント内のすべての Microsoft 365 グループを対象とするすべてのアクセス レビュー シリーズを取得する要求を示しています。
GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions?$filter=contains(scope/microsoft.graph.accessReviewQueryScope/query, './members')
応答
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/accessReviews/definitions",
"@odata.count": 1,
"value": [
{
"id": "cc701697-762c-439a-81f5-f58d680fde76",
"displayName": "Review guest access across Microsoft 365 groups",
"status": "InProgress",
"scope": {
"@odata.type": "#microsoft.graph.accessReviewQueryScope",
"query": "./members/microsoft.graph.user/?$count=true&$filter=(userType eq 'Guest')",
"queryType": "MicrosoftGraph"
},
"instanceEnumerationScope": {
"@odata.type": "#microsoft.graph.accessReviewQueryScope",
"query": "/groups?$filter=(groupTypes/any(c:c+eq+'Unified'))&$count=true",
"queryType": "MicrosoftGraph"
},
"reviewers": [
{
"query": "./manager",
"queryType": "MicrosoftGraph",
"queryRoot": "decisions"
}
],
"settings": {
"mailNotificationsEnabled": true,
"reminderNotificationsEnabled": true,
"justificationRequiredOnApproval": true,
"defaultDecisionEnabled": true,
"defaultDecision": "Recommendation",
"instanceDurationInDays": 25,
"autoApplyDecisionsEnabled": true,
"recommendationsEnabled": true,
"recurrence": {
"pattern": {
"type": "absoluteMonthly",
"interval": 3,
"month": 0,
"dayOfMonth": 0,
"daysOfWeek": [],
"firstDayOfWeek": "sunday",
"index": "first"
},
"range": {
"type": "numbered",
"numberOfOccurrences": 0,
"recurrenceTimeZone": null,
"startDate": "2021-04-27",
"endDate": "9999-12-31"
}
},
"applyActions": [
{
"@odata.type": "#microsoft.graph.removeAccessApplyAction"
}
]
},
"instances": []
}
]
}