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. To determine whether an API is available in v1.0, use the Version selector.

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

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Reports.Read.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Reports.Read.All Not available.

In delegated scenarios with work or school accounts, the signed-in user must be an owner or member of the group or be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

  • Reports Reader
  • Security Reader
  • Security Administrator
  • Global Reader

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.

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

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"
    }
  ]
}