Create custodians
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 ediscoveryCustodian 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.
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}/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 ediscoveryCustodian object.
You can specify the following properties when you create an ediscoveryCustodian.
Property | Type | Description |
---|---|---|
String | Custodian's primary SMTP address. Required. |
Response
If successful, this method returns a 201 Created
response code and an microsoft.graph.security.ediscoveryCustodian object in the response body.
Examples
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/{ediscoveryCaseId}/custodians
Content-Type: application/json
{
"email":"AdeleV@contoso.com",
}
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('4c8f8f70-7785-4bd4-b296-c98376a2c5e1')/custodians/$entity",
"status": "active",
"holdStatus": "applied",
"createdDateTime": "2022-05-23T00:58:19.0702426Z",
"lastModifiedDateTime": "2022-05-23T00:58:19.0702436Z",
"releasedDateTime": null,
"id": "0053a61a3b6c42738f7606791716a22a",
"displayName": "Adele Vance",
"email": "AdeleV@contoso.com",
"acknowledgedDateTime": "0001-01-01T00:00:00Z"
}
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應