Skip to content

security-ediscoverycustodian-post-usersources.md

Latest commit

 

History

History
143 lines (112 loc) · 5.37 KB

security-ediscoverycustodian-post-usersources.md

File metadata and controls

143 lines (112 loc) · 5.37 KB
title Create custodian userSource
description Create a new custodian userSource object associated with an eDiscovery custodian.
author SeunginLyu
ms.localizationpriority medium
ms.subservice ediscovery
doc_type apiPageType
ms.date 10/28/2024

Create custodian userSource

Namespace: microsoft.graph.security

Create a new userSource object associated with an eDiscovery custodian.

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

HTTP request

POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/custodians/{custodianId}/userSources

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

You can specify the following properties when you create a userSource. For more information, see Data sources in eDiscovery.

Property Type Description
email String SMTP address of the user.
includedSources microsoft.graph.security.sourceType Specifies which sources are included in this group. The possible values are: mailbox, site.

Response

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

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/custodians/0053a61a3b6c42738f7606791716a22a/userSources

{
    "email": "admin@contoso.com",
    "includedSources": "mailbox"
}

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/v1.0/$metadata#security/cases/ediscoveryCases('b0073e4e-4184-41c6-9eb7-8c8cc3e2288b')/custodians('0053a61a3b6c42738f7606791716a22a')/userSources/$entity",
    "displayName": "MOD Administrator",
    "createdDateTime": "0001-01-01T00:00:00Z",
    "holdStatus": "applied",
    "id": "c25c3914-f9f7-43ee-9cba-a25377e0cec6",
    "email": "admin@contoso.com",
    "includedSources": "mailbox,site",
    "siteWebUrl": "",
    "createdBy": {
        "user": {
            "id": "c25c3914-f9f7-43ee-9cba-a25377e0cec6",
            "displayName": "MOD Administrator",
            "userPrincipalName": "admin@contoso.com"
        },
        "application": {
            "id": "de8bc8b5-d9f9-48b1-a8ad-b748da725064",
            "displayName": "Graph Explorer"
        }
    }
}