Edit

Share via


Add ediscoveryCaseMember

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.

Add an ediscoveryCaseMember to an ediscoveryCase. The ediscoveryCaseMember can be one of two types: a user or a role group.

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 eDiscovery.Read.All eDiscovery.ReadWrite.All

HTTP request

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

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 only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property Type Description
recipientType microsoft.graph.security.recipientType Specifies the recipient type of the eDiscovery case member. The possible values are: user, roleGroup, unknownFutureValue. Required.
ID String The ID of the eDiscovery case member. If not specified, then either displayName (for role group) or smtpAddress (for user) must be provided.
displayName String The display name of the eDiscovery case member. Allowed only for case members of type roleGroup. If not specified, then ID must be provided.
smtpAddress String The smtp address of the eDiscovery case member. Allowed only for case members of type user. If not specified, then ID must be provided.

Response

If successful, this method returns a 200 OK response code and the added microsoft.graph.security.ediscoveryCaseMember object in the response body.

Examples

Example 1: Add a case member of type user using smtpAddress

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/caseMembers
Content-Type: application/json

{
    "recipientType": "user",
    "smtpAddress": "johnadams@microsoft.com"
}

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-Type: application/json

{  
    "@odata.type": "microsoft.graph.security.ediscoveryCaseMember",
    "recipientType": "user",
    "id": "c4af6f9d-37f6-43f9-9e17-601544234146",
    "displayName": "John Adams",
    "smtpAddress": "johnadams@microsoft.com"
}

Example 2: Add a case member of type roleGroup using displayName

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/caseMembers
Content-Type: application/json

{
    "recipientType": "roleGroup",
    "displayName": "Security Administrator"
}

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.type": "microsoft.graph.security.ediscoveryCaseMember",
    "recipientType": "roleGroup",
    "id": "b9fb4f22-5f90-47a0-b309-44fe96a959fd",
    "displayName": "Security Administrator",
    "smtpAddress": ""
}

Example 3: Add a case member of type user using *ID

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/caseMembers
Content-Type: application/json

{
    "recipientType": "user",
    "id": "c4af6f9d-37f6-43f9-9e17-601544234146"
}

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.type": "microsoft.graph.security.ediscoveryCaseMember",
    "recipientType": "user",
    "id": "c4af6f9d-37f6-43f9-9e17-601544234146",
    "displayName": "John Adams",
    "smtpAddress": "johnadams@microsoft.com"
}

Example 4: Add a case member of type roleGroup using ID

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/caseMembers
Content-Type: application/json

{
    "recipientType": "roleGroup",
    "id": "b9fb4f22-5f90-47a0-b309-44fe96a959fd"
}

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.type": "microsoft.graph.security.ediscoveryCaseMember",
    "recipientType": "roleGroup",
    "id": "b9fb4f22-5f90-47a0-b309-44fe96a959fd",
    "displayName": "Security Administrator",
    "smtpAddress": ""
}