Skip to content

ediscovery-case-post-custodians.md

Latest commit

 

History

History
140 lines (103 loc) · 4.92 KB

ediscovery-case-post-custodians.md

File metadata and controls

140 lines (103 loc) · 4.92 KB
title Create custodian
description Create a new custodian object.
author mahage-msft
ms.localizationpriority medium
ms.subservice ediscovery
doc_type apiPageType
ms.date 06/10/2024

Create custodian

Namespace: microsoft.graph.ediscovery

[!INCLUDE beta-disclaimer]

[!INCLUDE ediscovery-deprecation]

Create a new custodian object. After the custodian object is created, you will need to create the custodian's userSource to reference their mailbox and OneDrive for Business site.

[!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]

HTTP request

POST /compliance/ediscovery/cases/{caseId}/custodians

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 custodian object.

The following table lists the properties that are required when you create the custodian.

Property Type Description
email String Custodian's primary SMTP address. Required.
applyHoldToSources Boolean Indicates whether a hold is applied to the custodian's sources (such as mailboxes, sites, or Teams).

Response

If successful, this method returns a 201 Created response code and a microsoft.graph.ediscovery.custodian object in the response body.

Examples

Request

HTTP

POST https://graph.microsoft.com/beta/compliance/ediscovery/cases/2192ca408ea2410eba3bec8ae873be6b/custodians
Content-Type: application/json

{
    "email":"AdeleV@contoso.com",
    "applyHoldToSources":"true"
}

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

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#compliance/ediscovery/cases('4c8f8f70-7785-4bd4-b296-c98376a2c5e1')/custodians/$entity",
    "email": "AdeleV@contoso.com",
    "applyHoldToSources": false,
    "status": "active",
    "createdDateTime": "2020-10-30T20:47:01.7724531Z",
    "lastModifiedDateTime": "2020-10-30T20:47:02.2512381Z",
    "releasedDateTime": null,
    "acknowledgedDateTime": null,
    "id": "45353243323138344430413038363846",
    "displayName": "Adele Vance"
}