Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 3.17 KB

concept-reporting-api.md

File metadata and controls

68 lines (44 loc) · 3.17 KB
title description services documentationcenter author manager editor ms.assetid ms.service ms.devlang ms.topic ms.tgt_pltfrm ms.workload ms.component ms.date ms.author ms.reviewer
Get started with the Azure AD reporting API | Microsoft Docs
How to get started with the Azure Active Directory reporting API
active-directory
priyamohanram
mtillman
8813b911-a4ec-4234-8474-2eef9afea11e
active-directory
na
reference
na
identity
report-monitor
11/13/2018
priyamo
dhanyahk

Get started with the Azure Active Directory reporting API

Azure Active Directory provides you with a variety of reports, containing useful information for applications such as SIEM systems, audit, and business intelligence tools.

By using the Microsoft Graph API for Azure AD reports, you can gain programmatic access to the data through a set of REST-based APIs. You can call these APIs from a variety of programming languages and tools.

This article provides you with an overview of the reporting API, including ways to access it.

If you run into issues, see how to get support for Azure Active Directory.

Prerequisites

To access the reporting API, with or without user intervention, you need to:

  1. Assign roles (Security Reader, Security Admin, Global Admin)
  2. Register an application
  3. Grant permissions
  4. Gather configuration settings

For detailed instructions, see the prerequisites to access the Azure Active Directory reporting API.

API Endpoints

The Microsoft Graph API endpoint for audit logs is https://graph.microsoft.com/beta/auditLogs/directoryAudits and the Microsoft Graph API endpoint for sign-ins is https://graph.microsoft.com/beta/auditLogs/signIns. For more information, see the audit API reference and sign-in API reference.

APIs with Graph Explorer

You can use the MSGraph explorer to verify your sign-in and audit API data. Make sure to sign in to your account using both of the sign-in buttons in the Graph Explorer UI, and set AuditLog.Read.All and Directory.Read.All permissions for your tenant as shown.

Graph Explorer

Modify permissions UI

Use certificates to access the Azure AD reporting API

Use the Azure AD Reporting API with certificates if you plan to retrieve reporting data without user intervention.

For detailed instructions, see Get data using the Azure AD Reporting API with certificates.

Next steps