Edit

Create accessReviewScheduleDefinition

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.

Create a new user-centric (catalog-scope) accessReviewScheduleDefinition object through the unified route. With a user-centric review, a reviewer evaluates a principal's access to every group and application contained in an entitlement management catalog in a single review. The catalog is identified in the resourceScopes collection of the principalResourceMembershipsScope.

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.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application AccessReview.ReadWrite.All Not available.

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 write access reviews of a group or app: User Administrator, Identity Governance Administrator
  • To write access reviews of a Microsoft Entra role: Identity Governance Administrator, Privileged Role Administrator

HTTP request

POST /identityGovernance/accessReviews/unified/definitions

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the accessReviewScheduleDefinition object. Set the scope to a principalResourceMembershipsScope whose resourceScopes collection contains a resource scope of scopeType catalog that identifies the catalog to review.

Response

If successful, this method returns a 201 Created response code and an accessReviewScheduleDefinition object in the response body.

Examples

Example 1: Create a user-centric (catalog) access review definition

The following example creates a review in which the managers of all users review those users' access to every group and application contained in a catalog.

Request

POST https://graph.microsoft.com/beta/identityGovernance/accessReviews/unified/definitions
Content-type: application/json

{
    "displayName": "Catalog access review",
    "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"
        }
    ],
    "settings": {
        "mailNotificationsEnabled": true,
        "reminderNotificationsEnabled": true,
        "justificationRequiredOnApproval": true,
        "instanceDurationInDays": 6,
        "recommendationsEnabled": true,
        "recurrence": {
            "pattern": {
                "type": "absoluteMonthly",
                "interval": 1
            },
            "range": {
                "type": "noEnd",
                "startDate": "2026-08-31"
            }
        }
    }
}

Response

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

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

{
    "id": "29f2d16e-9ca6-4052-bbfe-802c48944448",
    "displayName": "Catalog access review",
    "status": "NotStarted",
    "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