Skip to content

security-ediscoverycase-post-legalholds.md

Latest commit

 

History

History
149 lines (120 loc) · 5.4 KB

security-ediscoverycase-post-legalholds.md

File metadata and controls

149 lines (120 loc) · 5.4 KB
title Create ediscoveryHoldPolicy
description Create a new ediscoveryHoldPolicy object.
author SeunginLyu
ms.localizationpriority medium
ms.subservice ediscovery
doc_type apiPageType
ms.date 10/29/2024

Create ediscoveryHoldPolicy

Namespace: microsoft.graph.security

[!INCLUDE beta-disclaimer]

Create a new ediscoveryHoldPolicy object.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table] [!INCLUDE rbac-rbac-ediscovery-apis-write]

HTTP request

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

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
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.
contentQuery String KQL query that specifies content to be held in the specified locations. 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 example shows 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",
    "contentQuery": "KQL content query",
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE 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
        }
    }
}