Skip to content

reportroot-getcredentialusagesummary.md

Latest commit

 

History

History
158 lines (111 loc) · 5.78 KB

reportroot-getcredentialusagesummary.md

File metadata and controls

158 lines (111 loc) · 5.78 KB
title reportRoot: getCredentialUsageSummary
description Report the current state of how many users in your organization are using self-service password reset capabilities.
ms.localizationpriority medium
author egreenberg14
ms.subservice entra-monitoring-health
doc_type apiPageType
ms.date 04/04/2024

reportRoot: getCredentialUsageSummary

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Report the current state of how many users in your organization used the self-service password reset capabilities.

[!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/getCredentialUsageSummary(period='{periodValue}')

Function parameters

You must use the following function parameter to request a timeframe for the response.

Parameter Type Description
period String Required. Specifies the time period in days for which you need the usage data. For example: /reports/getCredentialUsageSummary(period='D30'). Supported periods: D1, D7, and D30. Period is case insensitive.

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 credentialUsageSummary resource.

Properties Description and example
feature Specifies the type of usage data you want (registration vs. reset). For example: /reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'. Supported filter operators: eq.

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 new credentialUsageSummary collection object 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/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'

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.getCredentialUsageSummary)",
  "value":[
    {
      "id" : "id-value",
      "feature":"registration",
      "successfulActivityCount":12345,
      "failureActivityCount": 123,
      "authMethod": "email"
    }
  ]
}