title | description | ms.localizationpriority | doc_type | ms.subservice | author | ms.date |
---|---|---|---|---|---|---|
Activity reports API overview |
Use the activity reports API in Microsoft Graph to access the reports that Microsoft Entra creates to help you track user activity in a tenant. |
high |
conceptualPageType |
entra-monitoring-health |
egreenberg14 |
09/16/2022 |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Microsoft Entra ID tracks user activity and creates reports that help you understand how your users access and use Microsoft Entra services. Use the Microsoft Graph API for Microsoft Entra to analyze the data in these reports and to create custom solutions tailored to your organization's specific needs.
The availability of these activity reports is governed by the Microsoft Entra data retention policies. For more information, see data retention policies.
Microsoft Entra provides four types of activity reports:
- Directory audit logs
- Custom security attribute audit logs
- Sign-ins
- Provisioning
The directory audit report provides you with access to the history of every task performed in your tenant. The directory audit report provides you with records of system activities for compliance. Amongst others, the provided data enables you to address common scenarios such as:
- Who granted admin group access to a directory user?
- Which users are signing in to a recently acquired app?
- How many passwords resets were made within the directory?
Custom security attribute audit logs provide you with the history of activities related to custom security attributes, such as adding a new definition or assigning an attribute value to a user. Custom security attribute audit logs are separate from directory audit logs and have a different endpoint. To view custom security attribute audit logs, you must be assigned the Attribute Log Reader or Attribute Log Administrator role. By default, a Global Administrator doesn't have access to these audit logs.
The sign-ins report helps you determine who performed the tasks reported by directory audit logs. The sign-ins report helps you answer questions like:
- What is the sign in pattern of a user?
- How many users have signed in during the last week?
- What's the status of these sign-ins?
The provisioning report helps you see all the actions performed by the Microsoft Entra provisioning service. The provisioning report helps you answer questions like:
- What groups were successfully created in ServiceNow?
- What roles were imported from Amazon Web Services?
- What users were unsuccessfully created from Workday?
Here are popular requests for working with report data:
Operation | URL |
---|---|
GET tenant user activities | https://graph.microsoft.com/beta/auditLogs/directoryAudits |
GET custom security attribute audit logs | https://graph.microsoft.com/beta/auditLogs/customSecurityAttributeAudits |
GET tenant user sign-ins | https://graph.microsoft.com/beta/auditLogs/signIns |
GET provisioning logs | https://graph.microsoft.com/beta/auditLogs/provisioning |
Activity reports are available for features that you've licensed. If you have a license for a specific feature, you also have access to the reports. For more information about license requirements for the different activity reports, see Microsoft Entra audit logs: License and role requirements.
- Start working with the following resources representing the different activity reports:
- directoryAudit resource type.
- signIn resource type.
- provisioningObjectSummary resource type.
- customSecurityAttributeAudit resource type.