Edit

List accessReviewScheduleDefinitions

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Retrieve the accessReviewScheduleDefinition objects for user-centric (catalog-scope) access reviews through the unified route. A list of zero or more accessReviewScheduleDefinition objects is returned, including all of their nested properties, for each access review series created. This doesn't include the associated accessReviewInstance objects.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) AccessReview.Read.All AccessReview.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application AccessReview.Read.All AccessReview.ReadWrite.All

Important

For delegated access using work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role that grants the permissions required for this operation. This operation supports the following built-in roles, which provide only the least privilege necessary:

  • To read access reviews of a group or app: the creator of the access review; Global Reader, Security Reader, User Administrator, Identity Governance Administrator, Security Administrator

  • To read access reviews of a Microsoft Entra role: Security Reader, Identity Governance Administrator, Privileged Role Administrator, Security Administrator

HTTP request

GET /identityGovernance/accessReviews/unified/definitions

Optional query parameters

This method supports the $select, $top, $skip, and $filter OData query parameters to help customize the response. For general information, see OData query parameters.

The default page size for this API is 100 accessReviewScheduleDefinition objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the $skip and $top query parameters. For more information, see Paging Microsoft Graph data in your app.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body.

Response

If successful, this method returns a 200 OK response code and an array of accessReviewScheduleDefinition objects in the response body.

Examples

Example 1: List user-centric access review definitions

Request

GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/unified/definitions

Response

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/accessReviews/unified/definitions",
    "@odata.count": 1,
    "value": [
        {
            "id": "29f2d16e-9ca6-4052-bbfe-802c48944448",
            "displayName": "Catalog access review",
            "status": "InProgress",
            "descriptionForAdmins": "Quarterly user-centric review of catalog resources",
            "scope": {
                "@odata.type": "#microsoft.graph.principalResourceMembershipsScope",
                "principalScopes": [
                    {
                        "@odata.type": "#microsoft.graph.accessReviewPrincipalScope",
                        "scopeType": "allUsers"
                    }
                ],
                "resourceScopes": [
                    {
                        "@odata.type": "#microsoft.graph.accessReviewResourceScope",
                        "resourceId": "c6010d0c-ff41-4929-9776-fa03a03dd5ac",
                        "scopeType": "catalog"
                    }
                ]
            },
            "reviewers": [
                {
                    "@odata.type": "#microsoft.graph.accessReviewReviewerScope",
                    "scopeType": "manager"
                }
            ]
        }
    ]
}
  • Last updated on