Get accessReviewScheduleDefinition
Namespace: microsoft.graph
Read the properties and relationships of an accessReviewScheduleDefinition object.
To retrieve the instances of the access review series, use the list accessReviewInstance API.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | AccessReview.Read.All, AccessReview.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | AccessReview.Read.All, AccessReview.ReadWrite.All |
To call this API, the signed-in user must also be in a directory role that permits them to read an access review, or the user can be assigned as a reviewer on the access review. For more details, see the role and permission requirements for access reviews.
HTTP request
GET /identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinitionId}
Optional query parameters
This method supports $select
OData query parameter to help customize the response. For general information, see OData query parameters.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
Request body
Do not supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and an accessReviewScheduleDefinition object in the response body.
Examples
Request
GET https://graph.microsoft.com/v1.0/identityGovernance/accessReviews/definitions/3856fd6f-36e2-4152-97c9-76070d19f730
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": {
"id": "d6bf2f6c-2f6c-d6bf-6c2f-bfd66c2fbfd6",
"displayName": "Review example",
"status": "Applying",
"scope": {
"@odata.type": "#microsoft.graph.accessReviewQueryScope",
"query": "/v1.0/groups/4444d821-ca3b-45cc-98ee-54c00a04deef/transitiveMembers/microsoft.graph.user/?$count=true&$filter=(userType eq 'Guest')",
"queryType": "MicrosoftGraph",
"queryRoot": null
},
"reviewers": [
{
"query": "/v1.0/users/5555556e-fce3-4e2d-b28e-4ac0c7d2fa10",
"queryType": "MicrosoftGraph",
"queryRoot": null
}
],
"fallbackReviewers": [],
"instanceEnumerationScope": {
"@odata.type": "#microsoft.graph.accessReviewQueryScope",
"query": "/v1.0/groups/4444d821-ca3b-45cc-98ee-54c00a04deef",
"queryType": "MicrosoftGraph",
"queryRoot": null
},
"settings": {
"mailNotificationsEnabled": true,
"reminderNotificationsEnabled": true,
"justificationRequiredOnApproval": false,
"defaultDecisionEnabled": true,
"defaultDecision": "Deny",
"instanceDurationInDays": 10,
"autoApplyDecisionsEnabled": false,
"recommendationsEnabled": true,
"recurrence": {
"pattern": null,
"range": {
"type": "numbered",
"numberOfOccurrences": 0,
"recurrenceTimeZone": null,
"startDate": "2021-04-28",
"endDate": "2021-05-08"
}
},
"applyActions": [
{
"@odata.type": "#microsoft.graph.disableAndDeleteUserApplyAction"
}
]
}
}
}
See also
Feedback
Submit and view feedback for