You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
title: "Setting up app-only access for eDiscovery Microsoft Graph APIs"
3
-
description: "Steps to set up app-only access for eDiscovery Microsoft Graph APIs."
2
+
title: "Set up app-only access for Microsoft Purview eDiscovery by using Microsoft Graph APIs"
3
+
description: "Follow the steps to set up app-only access for eDiscovery Microsoft Graph APIs."
4
4
author: "pamehra"
5
5
ms.localizationpriority: high
6
6
ms.subservice: "security"
7
7
ms.custom: scenarios:getting-started
8
8
ms.date: 11/14/2024
9
9
---
10
10
11
-
# Setting up app-only access for Purview eDiscovery with Microsoft Graph API
11
+
# Set up app-only access for Microsoft Purview eDiscovery
12
12
13
-
The Microsoft Purview Microsoft Graph 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.
13
+
The Microsoft Purview APIs for eDiscovery in Microsoft Graph enable organizations to automate repetitive tasks and integrate with their existing eDiscovery tools to build repeatable workflows that industry regulations might require.
14
14
15
-
Implement app-only access using Microsoft Graph API to ensure secure and efficient access to needed resources. This step-by-step guide walks you through setting up app-only access for Purview eDiscovery, ensuring your applications are compliant and secure.
15
+
To better ensure secure and efficient access to resources, you can implement app-only access by using the Microsoft Graph API. This article walks you through how to set up app-only access for Microsoft Purview eDiscovery to help ensure that your applications are compliant and secure.
16
16
17
17
## Why app-only access?
18
18
19
19
### Enhancing security and compliance
20
20
21
-
App-only access enhances the security landscape of Purview eDiscovery by implementing robust authentication protocols that standard user credentials can't match. By using application (client) IDs and certificates for authentication, we minimize the risk of credential theft, which is a common vulnerability in standard authentication methods. This approach not only secures the application against unauthorized access but also ensures that the data integrity is maintained during the eDiscovery process.
21
+
App-only access enhances the security landscape of Microsoft Purview eDiscovery by implementing robust authentication protocols that standard user credentials can't match. By using application (client) IDs and certificates for authentication, you minimize the risk of credential theft, which is a common vulnerability in standard authentication methods. This approach not only helps to secure the application against unauthorized access, but also better ensures that the data integrity is maintained during the eDiscovery process.
22
22
23
23
### Streamlining access and integration
24
24
25
25
App-only access streamlines the integration of eDiscovery services with other applications and systems. It facilitates automated, script-based interactions that are crucial for large-scale legal investigations and compliance audits. By allowing secure, token-based access to eDiscovery resources, organizations can automate workflows, reduce manual errors, and ensure consistent enforcement of compliance policies across all digital environments.
26
26
27
-
## Implementing app-only access
27
+
## Implement app-only access
28
28
29
29
Implementing app-only access involves registering the app in Azure portal, creating client secret/certificates, assigning API permissions, setting up a service principal, and then using app-only access to call Microsoft Graph APIs. The following steps explain how to implement app-only access.
30
30
31
31
### Step 1: Register a new application in Azure
32
32
33
-
1.To begin, navigate to the Azure portal and sign in with your Microsoft account.
33
+
1.Go to the Azure portal and sign in with your Microsoft account.
34
34
35
-
2.Select **Microsoft Entra ID** on the left side of the Azure portal.
35
+
2.On the left pane of the Azure portal, select **Microsoft Entra ID**.
36
36
37
-
3.Expand **App registrations** on the left side of the Azure portal and select **New registration**.
37
+
3.On the left pane, expand **App registrations**, and select **New registration**.
38
38
39
-
4. Provide a meaningful name for your application and select register to create your new app registration. This process will generate essential details such as the Application (client) ID and Directory (tenant) ID, which are crucial for future steps.
39
+
4. Provide a meaningful name for your application and select **Register** to create your new app registration. This process generates essential details such as the Application (client) ID and Directory (tenant) ID, which are important for the next steps.
40
40
41
41
You can now see the newly created app registration and the details.
42
42
43
43

44
44
45
45
### Step 2: Create client secrets or certificates
46
46
47
-
Now that your app is registered, expand **Manage**on the left of the Azure portal, then select **Certificates & secrets**. Here, you can create a client secret or upload a certificate, depending on your authentication needs:
47
+
Now that your app is registered, on the left pane in the Azure portal, expand **Manage**, and then select **Certificates & secrets**. Here, you can create a client secret or upload a certificate, depending on your authentication needs:
48
48
49
-
For a client secret, select **New client secret**, add a description, and select **Add** to save it. Make sure to copy and securely store the secret value for authentication later. Otherwise, you may have to create a new secret.
49
+
For a client secret, select **New client secret**, add a description, and select **Add** to save it. Make sure to copy and securely store the secret value for authentication later. Otherwise, you might have to create a new secret.
50
50
51
51
You can optionally upload a certificate to use along with the application ID for automation purposes.
52
52
@@ -60,19 +60,19 @@ You need to set the correct API permissions for your application. Expand **Manag
60
60
61
61
### Step 4: Set up a service principal
62
62
63
-
1.In **Microsoft Entra ID** on the left of the Azure portal, select **Enterprise Applications** and search for your application by name to get the **Object ID** for your application.
63
+
1.On the left pane in the Azure portal, in **Microsoft Entra ID**, select **Enterprise Applications** and search for your application by name to get the **Object ID** for your application.
64
64
65
65

66
66
67
-
2. Open a new PowerShell session. Install and import the [ExchangeOnlineManagement](https://www.powershellgallery.com/packages/ExchangeOnlineManagement) module using the following cmdlets. The Install-Module cmdlet recommends upgrading the package if the module is already installed.
67
+
2. Open a new PowerShell session. Install and import the [ExchangeOnlineManagement](https://www.powershellgallery.com/packages/ExchangeOnlineManagement) module using the following cmdlets. The `Install-Module` cmdlet recommends upgrading the package if the module is already installed.
68
68
69
69
```powershell
70
70
Install-Module ExchangeOnlineManagement
71
71
Import-Module ExchangeOnlineManagement
72
72
Connect-IPPSSession
73
73
```
74
74
75
-
3. Use the [New-ServicePrincipal](/powershell/module/exchange/new-serviceprincipal) cmdlet to create a service principal with your app's details and verify it using [Get-ServicePrincipal](/powershell/module/exchange/get-serviceprincipal) cmdlet.
75
+
3. Use the [New-ServicePrincipal](/powershell/module/exchange/new-serviceprincipal) cmdlet to create a service principal with your app's details and verify it by using [Get-ServicePrincipal](/powershell/module/exchange/get-serviceprincipal) cmdlet.
76
76
77
77
Run the following cmdlets, replacing the **AppId**, **ObjectId**, and **DisplayName** arguments in the first cmdlet.
78
78
@@ -81,7 +81,7 @@ You need to set the correct API permissions for your application. Expand **Manag
81
81
Get-ServicePrincipal
82
82
```
83
83
84
-
4. Add the Service Principal Object ID to the eDiscoveryManager role using [Add-RoleGroupMember](/powershell/module/exchange/add-rolegroupmember) cmdlet and verify using [Get-RoleGroupMember](/powershell/module/exchange/get-rolegroupmember) cmdlet.
84
+
4. Add the Service Principal Object ID to the eDiscoveryManager role by using the [Add-RoleGroupMember](/powershell/module/exchange/add-rolegroupmember) cmdlet and verify by using the [Get-RoleGroupMember](/powershell/module/exchange/get-rolegroupmember) cmdlet.
85
85
86
86
Run the following cmdlets, replacing the **Member** argument in the first cmdlet.
87
87
@@ -90,7 +90,7 @@ You need to set the correct API permissions for your application. Expand **Manag
90
90
Get-RoleGroupMember -Identity "eDiscoveryManager"
91
91
```
92
92
93
-
5. Add the Service Principal Object ID to the eDiscoveryAdministrator role using [Add-eDiscoveryCaseAdmin](/powershell/module/exchange/add-ediscoverycaseadmin) cmdlet and verify using [Get-eDiscoveryCaseAdmin](/powershell/module/exchange/get-ediscoverycaseadmin) cmdlet.
93
+
5. Add the Service Principal Object ID to the eDiscoveryAdministrator role by using the [Add-eDiscoveryCaseAdmin](/powershell/module/exchange/add-ediscoverycaseadmin) cmdlet and verify by using the [Get-eDiscoveryCaseAdmin](/powershell/module/exchange/get-ediscoverycaseadmin) cmdlet.
94
94
95
95
Run the following cmdlets, replacing the **User** argument in the first cmdlet.
96
96
@@ -105,12 +105,12 @@ You need to set the correct API permissions for your application. Expand **Manag
105
105
106
106
Use the [Connect-MgGraph](/powershell/module/microsoft.graph.authentication/connect-mggraph) cmdlet to authenticate and connect to Microsoft Graph using the app-only access method in PowerShell. This setup enables your app to interact with Microsoft Graph securely.
107
107
108
-
### Step 6: Invoke Microsoft Graph API Requests
108
+
### Step 6: Invoke Microsoft Graph API requests
109
109
110
-
Once connected, you can start making calls to the Microsoft Graph API using the [Invoke-MgGraphRequest](/powershell/module/microsoft.graph.authentication/invoke-mggraphrequest) cmdlet. This cmdlet allows you to perform various operations required by eDiscovery services in your organization.
110
+
After you're connected, you can start making calls to the Microsoft Graph API by using the [Invoke-MgGraphRequest](/powershell/module/microsoft.graph.authentication/invoke-mggraphrequest) cmdlet. This cmdlet allows you to perform various operations required by eDiscovery services in your organization.
111
111
112
112
## Related content
113
113
114
114
Explore [Microsoft Graph tutorials](/graph/tutorials) to create basic applications that access data in app-only scenarios. For more information about app-only authentication, see [Get access without a user](/graph/auth-v2-service)
115
115
116
-
For API testing on Postman, see [Use Postman with the Microsoft Graph API](/graph/use-postman).
116
+
To test APIs on Postman, see [Use Postman with the Microsoft Graph API](/graph/use-postman).
0 commit comments