reportRoot: getCredentialUsageSummary

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.

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

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

HTTP request

GET /reports/getCredentialUsageSummary

Function parameters

You can use the following function parameter to adjust the response.

Parameter Type Description
period String Specifies the time period 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}
Content-Type application/json

Request body

Do not 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 is an example of the request.

GET https://graph.microsoft.com/beta/reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'

Response

The following is an example of 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"
    }
  ]
}