Skip to content

Commit 137e167

Browse files
authored
Merge pull request #25588 from microsoftgraph/ed-app-auth
eDiscovery overview and app auth concept documents
2 parents 60a2fdc + b035313 commit 137e167

15 files changed

+363
-3
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "Use the Microsoft Purview eDiscovery API in Microsoft Graph"
3+
description: "Use the Microsoft Purview eDiscovery API to automate repetitive tasks and integrate with their existing eDiscovery tools to build repeatable workflows that industry regulations might require."
4+
ms.localizationpriority: high
5+
author: "pamehra"
6+
ms.subservice: "ediscovery"
7+
ms.date: 11/11/2024
8+
doc_type: conceptualPageType
9+
---
10+
11+
# Use the Microsoft Purview eDiscovery API
12+
13+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
14+
15+
The Microsoft Purview APIs for eDiscovery enable organizations to automate repetitive tasks and integrate with their existing eDiscovery tools to build repeatable workflows that industry regulations might require. You can use the eDiscovery APIs to help with your legal needs.
16+
17+
> [!IMPORTANT]
18+
> The Microsoft Purview APIs for eDiscovery are intended for the use of eDiscovery operations for litigation, investigation, and regulatory requests. These APIs shouldn't be used as a substitute for journaling data out of the Microsoft 365 system or any other mass download.
19+
>
20+
> For information about setting up app-only access, see [Set up application authentication](/graph/security-ediscovery-appauthsetup).
21+
22+
> [!NOTE]
23+
> Usage of these APIs may require subscriptions to specific Microsoft offerings and is subject to the [Microsoft APIs Terms of Use](/legal/microsoft-apis/terms-of-use?context=graph%252fcontext). Upon general availability, Microsoft may require you or your customer to pay additional fees.
24+
>
25+
> Currently, the eDiscovery APIs in Microsoft Graph only work with eDiscovery (Premium) cases.
26+
27+
The eDiscovery APIs are defined in the OData subnamespace, microsoft.graph.security. The following table shows key entities in the eDiscovery API.
28+
29+
| Name | Type | Use case |
30+
|:---|:---|:---|
31+
| Case | [microsoft.graph.security.ediscoverycase](../resources/security-ediscoverycase.md) | The container for all eDiscovery objects including custodians, holds, searches, review sets, and exports.|
32+
| Case settings |[microsoft.graph.security.ediscoveryCaseSettings](../resources/security-ediscoverycasesettings.md) | The settings associated with the case.|
33+
| Custodian | [microsoft.graph.security.ediscoveryCustodian](../resources/security-ediscoverycustodian.md) | A person and the data they have administrative control over. When custodians are identified, eDiscovery can hold, search, cull, and export their data. For details, see [Work with custodians and noncustodial data sources in eDiscovery](/microsoft-365/compliance/managing-custodians).|
34+
| Non custodial data source| [microsoft.graph.security.ediscoveryNoncustodialDataSource](../resources/security-ediscoverynoncustodialdatasource.md) | The data sources to be added to a case without having to associate it to a custodian. When non custodial data sources are identified, eDiscovery can hold, search, cull, and export their data. For details, see [Work with custodians and noncustodial data sources in eDiscovery](/microsoft-365/compliance/managing-custodians).|
35+
| Search | [microsoft.graph.security.ediscoverySearch](../resources/security-ediscoverysearch.md) | Allows you to collect data from the Microsoft 365 live services such as Exchange, SharePoint, and Teams. Source collections can be added to a review set to further cull and eventually export data relevant to your case. For details, see [Collect data for a case in eDiscovery](/microsoft-365/compliance/collecting-data-for-ediscovery).|
36+
| Legal hold| [microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) | Content held for litigation and legal purposes. Legal holds shouldn't be confused with or used as retention holds, which are typically used to comply with government or industry regulations. To learn more, see [Manage holds in eDiscovery](/microsoft-365/compliance/managing-holds).|
37+
| Operation | [microsoft.graph.security.caseOperation](../resources/security-caseoperation.md) | Operations which can be performed on a case like adding to review set, applying tags, and so on.|
38+
| Review set | [microsoft.graph.security.ediscoveryReviewSet](../resources/security-ediscoveryreviewset.md) | The static set of electronically stored information collected for use in a litigation, investigation, or regulatory request.|
39+
| Tags | [microsoft.graph.security.ediscoveryReviewTag](../resources/security-ediscoveryreviewtag.md) | Used in a review set during review or culling to cull responsive data from nonresponsive data, identify privileged content, or generally aid in the review process. To learn more, see [Tag documents in a review set in eDiscovery](/microsoft-365/compliance/tagging-documents).|
40+

api-reference/beta/toc/security/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,8 @@ items:
276276
href: ../../api/security-endpointdiscoveredcloudappdetail-list-devices.md
277277
- name: eDiscovery
278278
items:
279+
- name: Overview
280+
href: ../../resources/security-ediscovery-apioverview.md
279281
- name: eDiscovery case
280282
items:
281283
- name: eDiscovery case

api-reference/beta/toc/toc.mapping.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2510,6 +2510,7 @@
25102510
},
25112511
{
25122512
"name": "eDiscovery",
2513+
"overview": "../../resources/security-ediscovery-apioverview.md",
25132514
"resources": [
25142515
"microsoft.graph.security.ediscoveryCase",
25152516
"microsoft.graph.security.ediscoveryCaseSettings",
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: "Use the Microsoft Purview eDiscovery API in Microsoft Graph"
3+
description: "Use the Microsoft Purview eDiscovery APIs to automate repetitive tasks and integrate with their existing eDiscovery tools to build repeatable workflows that industry regulations might require."
4+
ms.localizationpriority: high
5+
author: "pamehra"
6+
ms.subservice: "ediscovery"
7+
ms.date: 11/11/2024
8+
doc_type: conceptualPageType
9+
---
10+
11+
# Use the Microsoft Purview eDiscovery API
12+
13+
The Microsoft Purview APIs for eDiscovery enable organizations to automate repetitive tasks and integrate with their existing eDiscovery tools to build repeatable workflows that industry regulations might require. You can use the eDiscovery APIs to help with your legal needs.
14+
15+
> [!IMPORTANT]
16+
> The Microsoft Purview APIs for eDiscovery are intended for the use of eDiscovery operations for litigation, investigation, and regulatory requests. These APIs shouldn't be used as a substitute for journaling data out of the Microsoft 365 system or any other mass download.
17+
>
18+
> For information about setting up app-only access, see [Set up application authentication](/graph/security-ediscovery-appauthsetup).
19+
20+
> [!NOTE]
21+
> Usage of these APIs may require subscriptions to specific Microsoft offerings and is subject to the [Microsoft APIs Terms of Use](/legal/microsoft-apis/terms-of-use?context=graph%252fcontext). Upon general availability, Microsoft may require you or your customer to pay additional fees.
22+
>
23+
> Currently, the eDiscovery APIs in Microsoft Graph only work with eDiscovery (Premium) cases.
24+
25+
The eDiscovery APIs are defined in the OData subnamespace, microsoft.graph.security. The following table shows key entities in the eDiscovery API.
26+
27+
| Name | Type | Use case |
28+
|:---|:---|:---|
29+
| Case | [microsoft.graph.security.ediscoverycase](../resources/security-ediscoverycase.md) | The container for all eDiscovery objects including custodians, holds, searches, review sets, and exports.|
30+
| Case settings |[microsoft.graph.security.ediscoveryCaseSettings](../resources/security-ediscoverycasesettings.md) | The settings associated with the case.|
31+
| Custodian | [microsoft.graph.security.ediscoveryCustodian](../resources/security-ediscoverycustodian.md) | A person and the data they have administrative control over. When custodians are identified, *eDiscovery* can hold, search, cull, and export their data. For details, see [Work with custodians and noncustodial data sources in eDiscovery](/microsoft-365/compliance/managing-custodians).|
32+
| Non custodial data source| [microsoft.graph.security.ediscoveryNoncustodialDataSource](../resources/security-ediscoverynoncustodialdatasource.md) | The data sources to be added to a case without having to associate it to a custodian. When non custodial data sources are identified, eDiscovery can hold, search, cull, and export their data. For details, see [Work with custodians and noncustodial data sources in eDiscovery](/microsoft-365/compliance/managing-custodians).|
33+
| Search | [microsoft.graph.security.ediscoverySearch](../resources/security-ediscoverysearch.md) | Allows you to collect data from the Microsoft 365 live services such as Exchange, SharePoint, and Teams. Source collections can be added to a review set to further cull and eventually export data relevant to your case. For details, see [Collect data for a case in eDiscovery](/microsoft-365/compliance/collecting-data-for-ediscovery).|
34+
| Legal hold| [microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) | Content held for litigation and legal purposes. Legal holds shouldn't be confused with or used as retention holds, which are typically used to comply with government or industry regulations. To learn more, see [Manage holds in eDiscovery](/microsoft-365/compliance/managing-holds).|
35+
| Operation | [microsoft.graph.security.caseOperation](../resources/security-caseoperation.md) | Operations which can be performed on a case like adding to review set, applying tags, and so on.|
36+
| Review set | [microsoft.graph.security.ediscoveryReviewSet](../resources/security-ediscoveryreviewset.md) | The static set of electronically stored information collected for use in a litigation, investigation, or regulatory request.|
37+
| Tags | [microsoft.graph.security.ediscoveryReviewTag](../resources/security-ediscoveryreviewtag.md) | Used in a review set during review or culling to cull responsive data from nonresponsive data, identify privileged content, or generally aid in the review process. To learn more, see [Tag documents in a review set in eDiscovery](/microsoft-365/compliance/tagging-documents).|

api-reference/v1.0/toc/security/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,8 @@ items:
166166
href: ../../api/securityreportsroot-getattacksimulationtrainingusercoverage.md
167167
- name: eDiscovery
168168
items:
169+
- name: Overview
170+
href: ../../resources/security-ediscovery-apioverview.md
169171
- name: eDiscovery case
170172
items:
171173
- name: eDiscovery case

api-reference/v1.0/toc/toc.mapping.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1458,6 +1458,7 @@
14581458
},
14591459
{
14601460
"name": "eDiscovery",
1461+
"overview": "../../resources/security-ediscovery-apioverview.md",
14611462
"resources": [
14621463
"microsoft.graph.security.ediscoveryCase",
14631464
"microsoft.graph.security.ediscoveryCaseSettings",

0 commit comments

Comments
 (0)