reportRoot: getOffice365ActiveUserDetail

Namespace: microsoft.graph

Get details about Microsoft 365 active users.

This API is available in the following national cloud deployments.

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.

Note: For delegated permissions, to allow apps to read service usage reports on behalf of a user, the tenant administrator must assign the user the appropriate Microsoft Entra ID limited administrator role. For more information, see Authorization for APIs to read Microsoft 365 usage reports.

HTTP request

GET /reports/getOffice365ActiveUserDetail(period='{period_value}')
GET /reports/getOffice365ActiveUserDetail(date={date_value})

Function parameters

In the request URL, provide one of the following parameters with a valid value.

Note: You need to set either period or date in the URL.

This method supports the $format, $top, and $skipToken OData query parameters to customize the response. The default output type is text/csv. However, if you want to specify the output type, use the OData $format query parameter set to text/csv or application/json.

Request headers

Response

CSV

If successful, this method returns a 302 Found response that redirects to a preauthenticated download URL for the report. You can find this URL in the Location header of the response.

Preauthenticated download URLs are only valid for a short period of time (a few minutes) and don't require an Authorization header.

The CSV file contains the following column headers:

• Report Refresh Date
• User Principal Name
• Display Name
• Is Deleted
• Deleted Date
• hasExchangeLicense
• hasOneDriveLicense
• hasSharePointLicense
• hasSkypeForBusinessLicense
• hasYammerLicense*
• hasTeamsLicense*
• 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*
• teamsLicenseAssignDate*
• Assigned Products

*These columns aren't supported in Microsoft Graph China operated by 21Vianet.

JSON

If successful, this method returns a 200 OK response code and an office365ActiveUserDetail object in the response body.

The following properties in the office365ActiveUserDetail object aren't supported in Microsoft Graph China operated by 21Vianet:

• hasYammerLicense
• hasTeamsLicense
• yammerLastActivityDate
• teamsLastActivityDate
• yammerLicenseAssignDate
• teamsLicenseAssignDate

The default page size for this request is 200 items.

Example

CSV

The following example outputs CSV.

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/reports/getOffice365ActiveUserDetail(period='D7')?$format=text/csv

Response

The following example shows the response.

HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe

If you follow the 302 redirection, you can download a CSV file with the following schema.

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

The following example returns JSON.

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/reports/getOffice365ActiveUserDetail(period='D7')?$format=application/json

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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