Skip to content

authenticationmethodsroot-list-usereventssummary.md

Latest commit

 

History

History
148 lines (112 loc) · 6.76 KB

authenticationmethodsroot-list-usereventssummary.md

File metadata and controls

148 lines (112 loc) · 6.76 KB
title List userEventsSummary objects
description Get a list of the user SSPR and MFA registration and reset events as defined in the usereventssummary object.
author egreenberg14
ms.date 07/23/2025
ms.localizationpriority medium
ms.subservice entra-monitoring-health
doc_type apiPageType

List userEventsSummary objects

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a list of the user SSPR and MFA registration and reset events as defined in the usereventssummary object.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

[!INCLUDE rbac-reports-registration-usage-apis]

HTTP request

GET /reports/authenticationMethods/userEventsSummary

Optional query parameters

This method supports the $filter OData query parameter to help customize the response. You can apply $filter on one or more of the following properties of the usereventssummary resource. You may also apply the $top query parameter to limit the number of results returned to a specific number. The default and max $top parameter is 1000 records.

Property Description Example
feature Filter for only registration events. Supported filter operators: eq. /reports/authenticationMethods/userEventsSummary?$filter=feature eq 'registration'
isSuccess Filter for only events that were successful. Supported filter operators are: eq. /reports/authenticationMethods/userEventsSummary?$filter=isSuccess eq true
failureReason Filter for events equaling a specific failure reason. Supported filter operators are: eq. /reports/authenticationMethods/userEventsSummary?$filter=failureReason eq 'A system error has occurred.'.
authMethod Filter for events from a speficic authentication method type. Supported filter operators are: eq. /reports/authenticationMethods/userEventsSummary?$filter=authMethod eq 'microsoftAuthenticatorPush'
userDisplayName Filter by user name. Supported filter operators are: eq and startswith(). Supports case insensitive. /reports/authenticationMethods/userEventsSummary?$filter=userDisplayName eq 'Contoso'
userPrincipalName Filter by user principal name. Supported filter operators are: eq and startswith(). Supports case insensitive. /reports/authenticationMethods/userEventsSummary?$filter=userPrincipalName eq 'Contoso'

Request headers

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

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of userEventsSummary objects in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/reports/authenticationMethods/userEventsSummary

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the 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#reports/authenticationMethods/userEventsSummary",  
  "value": [
    {
      "@odata.type": "#microsoft.graph.userEventsSummary",
      "id": "3604e35c-12f3-a86a-5ff4-97aecf6c526a",
      "feature": "registration",
      "userPrincipalName": "johndoe@contoso.net",
      "userDisplayName": "John Doe",
      "isSuccess": true,
      "authMethod": "microsoftAuthenticatorPush",
      "failureReason": "",
      "eventDateTime": "2025-07-16T16:19:18Z"
    }
  ]
}