reportRoot: getOffice365ActiveUserDetail
命名空间:microsoft.graph
重要
Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
获取有关 Microsoft 365 活动用户的详细信息。
备注: 若要了解不同报表视图和名称的详细信息,请参阅 Microsoft 365 报表 - 活动用户。
权限
要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限。
| 权限类型 | 权限(从最低特权到最高特权) |
|---|---|
| 委派(工作或学校帐户) | Reports.Read.All |
| 委派(个人 Microsoft 帐户) | 不支持。 |
| 应用 | Reports.Read.All |
注意:若要获得委派权限以允许应用代表用户读取服务使用情况报告,租户管理员必须事先为用户分配适当的 Azure AD 受限管理员角色。 有关更多详细信息,请参阅授权 API 读取 Microsoft 365 使用情况报告。
HTTP 请求
GET /reports/getOffice365ActiveUserDetail(period='{period_value}')
GET /reports/getOffice365ActiveUserDetail(date={date_value})
函数参数
在请求 URL 中,提供以下任一参数的有效值。
| 参数 | 类型 | 说明 |
|---|---|---|
| period | string | 指定在多长时间内聚合报表。 受支持的 {period_value} 值为:D7、D30、D90 和 D180。 这些值采用格式 D n,其中 n 表示在多少天内聚合报表。 |
| date | Date | 指定要查看用户在哪个日期执行的任何活动。 {date_value} 必须采用格式 YYYY-MM-DD。 因为此报表的有效期仅为过去 30 天,所以 {date_value} 应为这个范围内的日期。 |
注意: 需要在 URL 中设置 period 或 date。
此方法支持使用 $format、$top 和 $skipToken OData 查询参数自定义响应。 默认输出类型为 text/csv。 但是,如果要指定输出类型,可以使用 OData 查询参数$format text/csv 或 application/json。
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | Bearer {token}。必需。 |
响应
CSV
如果成功,此方法返回 302 Found 响应,以重定向到报表的预先验证的下载 URL。 可以在响应的 Location 头中找到此 URL。
预先验证的下载 URL 的有效时间很短(几分钟),不需要 Authorization 标头。
CSV 文件包含下面的列标题:
- 报表刷新日期
- 用户主体名称
- 显示名称
- 已删除
- 删除日期
- 拥有 Exchange 许可证
- 拥有 OneDrive 许可证
- 拥有 SharePoint 许可证
- 拥有 Skype for Business 许可证
- 拥有 Yammer 许可证
- 拥有 Teams 许可证
- Exchange 上次活动日期
- OneDrive 上次活动日期
- SharePoint 上次活动日期
- Skype for Business 上次活动日期
- Yammer 上次活动日期
- Teams 上次活动日期
- Exchange 许可证分配日期
- OneDrive 许可证分配日期
- SharePoint 许可证分配日期
- Skype for Business 许可证分配日期
- Yammer 许可证分配日期
- Teams 许可证分配日期
- 分配的产品
由世纪Graph运营的 Microsoft Graph不支持以下列:
- 拥有 Yammer 许可证
- 拥有 Teams 许可证
- Yammer 上次活动日期
- Teams 上次活动日期
- Yammer 许可证分配日期
- Teams 许可证分配日期
JSON
如果成功,此方法在响应 200 OK 正文中返回 响应代码和 office365ActiveUserDetail 对象。
由世纪银行运营的 Microsoft Graph不支持 office365ActiveUserDetail 对象中的以下属性:
- hasYammerLicense
- hasTeamsLicense
- yammerLastActivityDate
- teamsLastActivityDate
- yammerLicenseAssignDate
- teamsLicenseAssignDate
此请求的默认页面大小为 200 个项目。
示例
CSV
下面是输出 CSV 的示例。
请求
下面展示了示例请求。
GET https://graph.microsoft.com/beta/reports/getOffice365ActiveUserDetail(period='D7')?$format=text/csv
响应
下面展示了示例响应。
HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe
执行 302 重定向,下载的 CSV 文件将采用以下架构。
HTTP/1.1 200 OK
Content-Type: application/octet-stream
Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Has Exchange License,Has OneDrive License,Has SharePoint License,Has Skype For Business License,Has Yammer License,Has Teams License,Exchange Last Activity Date,OneDrive Last Activity Date,SharePoint Last Activity Date,Skype For Business Last Activity Date,Yammer Last Activity Date,Teams Last Activity Date,Exchange License Assign Date,OneDrive License Assign Date,SharePoint License Assign Date,Skype For Business License Assign Date,Yammer License Assign Date,Teams License Assign Date,Assigned Products
JSON
下面是返回 JSON 的示例。
请求
下面展示了示例请求。
GET https://graph.microsoft.com/beta/reports/getOffice365ActiveUserDetail(period='D7')?$format=application/json
响应
下面展示了示例响应。
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 853
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.office365ActiveUserDetail)",
"value": [
{
"reportRefreshDate": "2017-09-01",
"userPrincipalName": "userprincipalname-value",
"displayName": "displayname-value",
"isDeleted": false,
"deletedDate": null,
"hasExchangeLicense": true,
"hasOneDriveLicense": false,
"hasSharePointLicense": false,
"hasSkypeForBusinessLicense": false,
"hasYammerLicense": false,
"hasTeamsLicense": false,
"exchangeLastActivityDate": "2017-08-30",
"oneDriveLastActivityDate": null,
"sharePointLastActivityDate": null,
"skypeForBusinessLastActivityDate": null,
"yammerLastActivityDate": null,
"teamsLastActivityDate": null,
"exchangeLicenseAssignDate": "2016-05-03",
"oneDriveLicenseAssignDate": null,
"sharePointLicenseAssignDate": null,
"skypeForBusinessLicenseAssignDate": null,
"yammerLicenseAssignDate": null,
"teamsLicenseAssignDate": null,
"assignedProducts": [
"Microsoft 365 ENTERPRISE E5"
]
}
]
}
反馈
提交和查看相关反馈