userProcessingResult: summary

Namespace: microsoft.graph.identityGovernance

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.

Provide a summary of user processing results for a specified time period. Because the amount of user processing results returned by the List API call can be overwhelming, this summary allows the administrator to get a quick overview based on counts.

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

For delegated scenarios, the admin needs the Global Reader or Lifecycle Workflows Administrator Azure AD role.

HTTP request

GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/userProcessingResults/summary(startDateTime={TimeStamp},endDateTime={TimeStamp})

Function parameters

In the request URL, provide the following query parameters with values.

Parameter	Type	Description
startDateTime	DateTimeOffset	The start date and time of the user processing result summary.
endDateTime	DateTimeOffset	The end date and time of the user processing result summary

Optional query parameters

This method supports the $count, $orderBy, $expand, and $filter OData query parameters 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 function returns a 200 OK response code and a microsoft.graph.identityGovernance.userSummary in the response body.

Examples

Request

The following is an example of a request.

GET https://graph.microsoft.com/beta/IdentityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/userProcessingResults/summary(startDateTime=2022-07-20T00:00:00Z,endDateTime=2022-07-23T00:00:00Z)

Response

The following is an example of the response

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.identityGovernance.userSummary",
    "failedTasks": 0,
    "failedUsers": 0,
    "successfulUsers": 2,
    "totalTasks": 4,
    "totalUsers": 2
}