Create legalHold userSource

Namespace: microsoft.graph.ediscovery


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.

Adds a userSource to a legalHold object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet


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 /compliance/ediscovery/cases/{caseId}/legalHolds/{legalholdId}/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.

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

Property Type Description
email String SMTP address of the user or the SMTP address of the group mailbox. To get the email address of the group, use List groups or Get group. Using get group, you can query by the name of the group using $filter; for example,$filter=displayName eq 'secret group'&$select=mail,id,displayName.
includedSources microsoft.graph.ediscovery.sourceType Specifies which sources are included in this group. This value must be mailbox, site is not supported for legalHolds at this time.


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



Content-Type: application/json

  "email": "",
  "includedSources": "mailbox"


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

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

    "@odata.context": "$metadata#compliance/ediscovery/cases/c816dd6f-5af8-40c5-a760-331361e05c60/legalholds/387566cc-38ae-4e85-ab4b-cd2dd34faa07/userSources",
    "value": [
            "displayName": "Adele Vance",
            "createdDateTime": "2020-12-28T20:08:57.857Z",
            "id": "2192ca40-8ea2-410e-ba3b-ec8ae873be6b",
            "email": "",
            "includedSources": "mailbox",
            "createdBy": {
                "user": {
                    "id": null,
                    "displayName": "EDiscovery admin"