Skip to content

reportroot-list-usercredentialusagedetails.md

Latest commit

 

History

History
159 lines (114 loc) · 6.54 KB

reportroot-list-usercredentialusagedetails.md

File metadata and controls

159 lines (114 loc) · 6.54 KB
title List userCredentialUsageDetails
description Get a list of userCredentialUsageDetails objects for a given tenant.
ms.localizationpriority medium
author egreenberg14
ms.subservice entra-monitoring-health
doc_type apiPageType
ms.date 04/04/2024

List userCredentialUsageDetails

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a list of userCredentialUsageDetails objects for a given tenant. Details include user information, status of the reset, and the reason for failure.

[!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/userCredentialUsageDetails

Optional query parameters

This function supports the optional OData query parameter $filter. You can apply $filter on one or more of the following properties of the userCredentialUsageDetails resource.

Properties Description and example
feature Filter by type of usage data that you want (registration vs reset). For example: /reports/userCredentialUsageDetails?$filter=feature eq 'registration'. Supported filter operators: eq
userDisplayName Filter by user display name. For example: /reports/userCredentialUsageDetails?$filter=userDisplayName eq 'Contoso'. Supported filter operators: eq and startswith(). Supports case insensitive.
userPrincipalName Filter by user principal name. For example: /reports/userCredentialUsageDetails?$filter=userPrincipalName eq 'Contoso'. Supported filter operators: eq and startswith(). Supports case insensitive.
isSuccess Filter by status of the activity. For example: /reports/userCredentialUsageDetails?$filter=isSuccess eq true. Supported filter operators: eq and orderby.
authMethod Filter by the authentication methods using during registration. For example: /reports/userCredentialUsageDetails?$filter=authMethod eq microsoft.graph.usageAuthMethod'email'. Supported filter operators: eq.
failureReason Filter by failure reason (if the activity has failed). For example: /reports/userCredentialUsageDetails?$filter=failureReason eq 'Contoso'. Supported filter operators: eq and startswith(). Supports case insensitive.

Request headers

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

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 userCredentialUsageDetails objects in the response body.

Examples

The following example shows how to call this API.

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/reports/userCredentialUsageDetails

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. All the properties are returned from an actual call.

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

{
  "@odata.context":"https://graph.microsoft.com/beta/reports/$metadata#Collection(microsoft.graph.getUserCredentialUsageDetails)",
  "value":[
    {
      "id" : "id-value",
      "feature":"registration",
      "userPrincipalName":"userPrincipalName-value",
      "userDisplayName": "userDisplayName-value",
      "isSuccess" : true,
      "authMethod": "email",
      "failureReason": "User contacted an admin after trying the email verification option",
      "eventDateTime" : "2019-04-01T00:00:00Z"
    }
  ]
}