Create ediscoveryHoldPolicy

Namespace: microsoft.graph.security

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create a new ediscoveryHoldPolicy object.

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)	eDiscovery.Read.All	eDiscovery.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

HTTP request

POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the ediscoveryHoldPolicy object.

You can specify the following properties when you create an ediscoveryHoldPolicy.

Property	Type	Description
displayName	String	The display name of the legal hold policy. Required.
description	String	The description of the legal hold policy. Optional.

Response

If successful, this method returns a 201 Created response code and an microsoft.graph.security.ediscoveryHoldPolicy object in the response body.

Examples

Request

The following is an example of a request.

HTTP

POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalHolds
Content-Type: application/json

{
    "displayName": "My legalHold with sources",
    "description": "Created from Graph API",
    "userSources@odata.bind": [
        {
            "@odata.type": "microsoft.graph.security.userSource",
            "email": "SalesTeam@M365x809305.OnMicrosoft.com"
        }
    ],
    "siteSources@odata.bind": [
        {
            "@odata.type": "microsoft.graph.security.siteSource",
            "site": {
                "webUrl": "https://m365x809305.sharepoint.com/sites/Design-topsecret"
            }
        }
    ]
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models.Security;

var requestBody = new EdiscoveryHoldPolicy
{
	DisplayName = "My legalHold with sources",
	Description = "Created from Graph API",
	AdditionalData = new Dictionary<string, object>
	{
		{
			"userSources@odata.bind" , new List<object>
			{
				new 
				{
					OdataType = "microsoft.graph.security.userSource",
					Email = "SalesTeam@M365x809305.OnMicrosoft.com",
				},
			}
		},
		{
			"siteSources@odata.bind" , new List<object>
			{
				new 
				{
					OdataType = "microsoft.graph.security.siteSource",
					Site = new 
					{
						WebUrl = "https://m365x809305.sharepoint.com/sites/Design-topsecret",
					},
				},
			}
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Cases.EdiscoveryCases["{ediscoveryCase-id}"].LegalHolds.PostAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta security cases ediscovery-cases legal-holds create --ediscovery-case-id {ediscoveryCase-id} --body '{\
    "displayName": "My legalHold with sources",\
    "description": "Created from Graph API",\
    "userSources@odata.bind": [\
        {\
            "@odata.type": "microsoft.graph.security.userSource",\
            "email": "SalesTeam@M365x809305.OnMicrosoft.com"\
        }\
    ],\
    "siteSources@odata.bind": [\
        {\
            "@odata.type": "microsoft.graph.security.siteSource",\
            "site": {\
                "webUrl": "https://m365x809305.sharepoint.com/sites/Design-topsecret"\
            }\
        }\
    ]\
}\
'

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

EdiscoveryHoldPolicy ediscoveryHoldPolicy = new EdiscoveryHoldPolicy();
ediscoveryHoldPolicy.displayName = "My legalHold with sources";
ediscoveryHoldPolicy.description = "Created from Graph API";
ediscoveryHoldPolicy.additionalDataManager().put("userSources@odata.bind", new JsonPrimitive("[  {    \"@odata.type\": \"microsoft.graph.security.userSource\",    \"email\": \"SalesTeam@M365x809305.OnMicrosoft.com\"  }]"));
ediscoveryHoldPolicy.additionalDataManager().put("siteSources@odata.bind", new JsonPrimitive("[  {    \"@odata.type\": \"microsoft.graph.security.siteSource\",    \"site\": {      \"webUrl\": \"https://m365x809305.sharepoint.com/sites/Design-topsecret\"    }  }]"));

graphClient.security().cases().ediscoveryCases("b0073e4e-4184-41c6-9eb7-8c8cc3e2288b").legalHolds()
	.buildRequest()
	.post(ediscoveryHoldPolicy);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const ediscoveryHoldPolicy = {
    displayName: 'My legalHold with sources',
    description: 'Created from Graph API',
    'userSources@odata.bind': [
        {
            '@odata.type': 'microsoft.graph.security.userSource',
            email: 'SalesTeam@M365x809305.OnMicrosoft.com'
        }
    ],
    'siteSources@odata.bind': [
        {
            '@odata.type': 'microsoft.graph.security.siteSource',
            site: {
                webUrl: 'https://m365x809305.sharepoint.com/sites/Design-topsecret'
            }
        }
    ]
};

await client.api('/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalHolds')
	.version('beta')
	.post(ediscoveryHoldPolicy);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW VERSION OF THE SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new EdiscoveryHoldPolicy();
$requestBody->setDisplayName('My legalHold with sources');
$requestBody->setDescription('Created from Graph API');
$additionalData = [
	'userSources@odata.bind' => [
			[
				'@odata.type' => 'microsoft.graph.security.userSource',
				'email' => 'SalesTeam@M365x809305.OnMicrosoft.com',
			],
		],
	'siteSources@odata.bind' => [
			[
				'@odata.type' => 'microsoft.graph.security.siteSource',
				'site' => [
					'webUrl' => 'https://m365x809305.sharepoint.com/sites/Design-topsecret',
				],
			],
		],
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->security()->cases()->ediscoveryCases()->byEdiscoveryCaseId('ediscoveryCase-id')->legalHolds()->post($requestBody)->wait();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Beta.Security

$params = @{
	displayName = "My legalHold with sources"
	description = "Created from Graph API"
	"userSources@odata.bind" = @(
		@{
			"@odata.type" = "microsoft.graph.security.userSource"
			email = "SalesTeam@M365x809305.OnMicrosoft.com"
		}
	)
	"siteSources@odata.bind" = @(
		@{
			"@odata.type" = "microsoft.graph.security.siteSource"
		}
	)
}

New-MgBetaSecurityCaseEdiscoveryCaseLegalHold -EdiscoveryCaseId $ediscoveryCaseId -BodyParameter $params

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# THE PYTHON SDK IS IN PREVIEW. FOR NON-PRODUCTION USE ONLY

graph_client = GraphServiceClient(credentials, scopes)

request_body = EdiscoveryHoldPolicy(
	display_name = "My legalHold with sources",
	description = "Created from Graph API",
	additional_data = {
			"user_sources@odata_bind" : [
				{
						"@odata_type" : "microsoft.graph.security.userSource",
						"email" : "SalesTeam@M365x809305.OnMicrosoft.com",
				},
			],
			"site_sources@odata_bind" : [
				{
						"@odata_type" : "microsoft.graph.security.siteSource",
						"site" : {
								"web_url" : "https://m365x809305.sharepoint.com/sites/Design-topsecret",
						},
				},
			],
	}
)

result = await graph_client.security.cases.ediscovery_cases.by_ediscovery_case_id('ediscoveryCase-id').legal_holds.post(request_body)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#security/cases/ediscoveryCases('b0073e4e-4184-41c6-9eb7-8c8cc3e2288b')/legalHolds/$entity",
    "isEnabled": true,
    "errors": [],
    "description": "Created from Graph API",
    "createdDateTime": "2022-05-23T03:54:11.1Z",
    "lastModifiedDateTime": "2022-05-23T03:54:11.1Z",
    "status": "pending",
    "id": "b9758bbc-ddbd-45e0-8484-3eb49cf1ded3",
    "displayName": "My legalHold with sources",
    "createdBy": {
        "application": null,
        "user": {
            "id": "MOD Administrator",
            "displayName": null
        }
    },
    "lastModifiedBy": {
        "application": null,
        "user": {
            "id": "MOD Administrator",
            "displayName": null
        }
    }
}