Get adminReportSettings
Namespace: microsoft.graph
Get the tenant-level settings for Microsoft 365 reports.
Note: For details about different report views and names, see Microsoft 365 Reports in the admin center - Microsoft 365 Apps usage.
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) | ReportSettings.Read.All | ReportSettings.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | ReportSettings.Read.All | ReportSettings.ReadWrite.All |
Note: For delegated permissions to allow apps to get report settings on behalf of a user, the tenant administrator must have assigned 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 /admin/reportSettings
Optional query parameters
This method supports the $select
OData query parameter to help customize the response.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and an adminReportSettings object in the response body.
Examples
Request
The following example shows a request.
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
{
"value": {
"@odata.type": "#microsoft.graph.adminReportSettings",
"displayConcealedNames": true
}
}