reportRoot: getCredentialUsageSummary

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

报告组织中有多少用户使用自助密码重置功能的当前状态。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Reports.Read.All 不可用。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用 Reports.Read.All 不可用。

对于委托方案,调用用户必须至少具有以下Microsoft Entra角色之一:

  • 报告读取者
  • 安全读取者
  • 安全管理员
  • 全局读取者

HTTP 请求

GET /reports/getCredentialUsageSummary(period='{periodValue}')

函数参数

必须使用以下函数参数来请求响应的时间范围。

参数 类型 说明
period String 必需。 指定需要使用情况数据的时间段(以天为单位)。 例如:/reports/getCredentialUsageSummary(period='D30')。 支持的时间段: D1D7D30。 期间不区分大小写。

可选的查询参数

此函数支持可选的 OData 查询参数 $filter。 可以对 credentialUsageSummary 资源的一个或多个以下属性应用$filter

属性 说明和示例
特征 指定要 (注册与重置) 的使用情况数据类型。 例如:/reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'。 支持的筛选器运算符: eq

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法在响应正文中返回响应 200 OK 代码和新的 credentialUsageSummary 集合对象。

示例

以下示例演示如何调用此 API。

请求

以下示例显示了一个请求。

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

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。 所有属性都是从实际调用返回的。

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