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 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"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.Security;
var requestBody = new EdiscoveryCaseMember
{
RecipientType = RecipientType.User,
SmtpAddress = "johnadams@microsoft.com",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Cases.EdiscoveryCases["{ediscoveryCase-id}"].CaseMembers.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodelssecurity "github.com/microsoftgraph/msgraph-beta-sdk-go/models/security"
//other-imports
)
requestBody := graphmodelssecurity.NewEdiscoveryCaseMember()
recipientType := graphmodels.USER_RECIPIENTTYPE
requestBody.SetRecipientType(&recipientType)
smtpAddress := "johnadams@microsoft.com"
requestBody.SetSmtpAddress(&smtpAddress)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
caseMembers, err := graphClient.Security().Cases().EdiscoveryCases().ByEdiscoveryCaseId("ediscoveryCase-id").CaseMembers().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.models.security.EdiscoveryCaseMember ediscoveryCaseMember = new com.microsoft.graph.beta.models.security.EdiscoveryCaseMember();
ediscoveryCaseMember.setRecipientType(EnumSet.of(com.microsoft.graph.beta.models.security.RecipientType.User));
ediscoveryCaseMember.setSmtpAddress("johnadams@microsoft.com");
com.microsoft.graph.models.security.EdiscoveryCaseMember result = graphClient.security().cases().ediscoveryCases().byEdiscoveryCaseId("{ediscoveryCase-id}").caseMembers().post(ediscoveryCaseMember);
const options = {
authProvider,
};
const client = Client.init(options);
const ediscoveryCaseMember = {
recipientType: 'user',
smtpAddress: 'johnadams@microsoft.com'
};
await client.api('/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/caseMembers')
.version('beta')
.post(ediscoveryCaseMember);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Security\EdiscoveryCaseMember;
use Microsoft\Graph\Beta\Generated\Models\Security\RecipientType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new EdiscoveryCaseMember();
$requestBody->setRecipientType(new RecipientType('user'));
$requestBody->setSmtpAddress('johnadams@microsoft.com');
$result = $graphServiceClient->security()->cases()->ediscoveryCases()->byEdiscoveryCaseId('ediscoveryCase-id')->caseMembers()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Security
$params = @{
recipientType = "user"
smtpAddress = "johnadams@microsoft.com"
}
New-MgBetaSecurityCaseEdiscoveryCaseMember -EdiscoveryCaseId $ediscoveryCaseId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.security.ediscovery_case_member import EdiscoveryCaseMember
from msgraph_beta.generated.models.recipient_type import RecipientType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = EdiscoveryCaseMember(
recipient_type = RecipientType.User,
smtp_address = "johnadams@microsoft.com",
)
result = await graph_client.security.cases.ediscovery_cases.by_ediscovery_case_id('ediscoveryCase-id').case_members.post(request_body)
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"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.Security;
var requestBody = new EdiscoveryCaseMember
{
RecipientType = RecipientType.RoleGroup,
DisplayName = "Security Administrator",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Cases.EdiscoveryCases["{ediscoveryCase-id}"].CaseMembers.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodelssecurity "github.com/microsoftgraph/msgraph-beta-sdk-go/models/security"
//other-imports
)
requestBody := graphmodelssecurity.NewEdiscoveryCaseMember()
recipientType := graphmodels.ROLEGROUP_RECIPIENTTYPE
requestBody.SetRecipientType(&recipientType)
displayName := "Security Administrator"
requestBody.SetDisplayName(&displayName)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
caseMembers, err := graphClient.Security().Cases().EdiscoveryCases().ByEdiscoveryCaseId("ediscoveryCase-id").CaseMembers().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.models.security.EdiscoveryCaseMember ediscoveryCaseMember = new com.microsoft.graph.beta.models.security.EdiscoveryCaseMember();
ediscoveryCaseMember.setRecipientType(EnumSet.of(com.microsoft.graph.beta.models.security.RecipientType.RoleGroup));
ediscoveryCaseMember.setDisplayName("Security Administrator");
com.microsoft.graph.models.security.EdiscoveryCaseMember result = graphClient.security().cases().ediscoveryCases().byEdiscoveryCaseId("{ediscoveryCase-id}").caseMembers().post(ediscoveryCaseMember);
const options = {
authProvider,
};
const client = Client.init(options);
const ediscoveryCaseMember = {
recipientType: 'roleGroup',
displayName: 'Security Administrator'
};
await client.api('/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/caseMembers')
.version('beta')
.post(ediscoveryCaseMember);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Security\EdiscoveryCaseMember;
use Microsoft\Graph\Beta\Generated\Models\Security\RecipientType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new EdiscoveryCaseMember();
$requestBody->setRecipientType(new RecipientType('roleGroup'));
$requestBody->setDisplayName('Security Administrator');
$result = $graphServiceClient->security()->cases()->ediscoveryCases()->byEdiscoveryCaseId('ediscoveryCase-id')->caseMembers()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Security
$params = @{
recipientType = "roleGroup"
displayName = "Security Administrator"
}
New-MgBetaSecurityCaseEdiscoveryCaseMember -EdiscoveryCaseId $ediscoveryCaseId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.security.ediscovery_case_member import EdiscoveryCaseMember
from msgraph_beta.generated.models.recipient_type import RecipientType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = EdiscoveryCaseMember(
recipient_type = RecipientType.RoleGroup,
display_name = "Security Administrator",
)
result = await graph_client.security.cases.ediscovery_cases.by_ediscovery_case_id('ediscoveryCase-id').case_members.post(request_body)
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"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.Security;
var requestBody = new EdiscoveryCaseMember
{
RecipientType = RecipientType.User,
Id = "c4af6f9d-37f6-43f9-9e17-601544234146",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Cases.EdiscoveryCases["{ediscoveryCase-id}"].CaseMembers.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodelssecurity "github.com/microsoftgraph/msgraph-beta-sdk-go/models/security"
//other-imports
)
requestBody := graphmodelssecurity.NewEdiscoveryCaseMember()
recipientType := graphmodels.USER_RECIPIENTTYPE
requestBody.SetRecipientType(&recipientType)
id := "c4af6f9d-37f6-43f9-9e17-601544234146"
requestBody.SetId(&id)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
caseMembers, err := graphClient.Security().Cases().EdiscoveryCases().ByEdiscoveryCaseId("ediscoveryCase-id").CaseMembers().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.models.security.EdiscoveryCaseMember ediscoveryCaseMember = new com.microsoft.graph.beta.models.security.EdiscoveryCaseMember();
ediscoveryCaseMember.setRecipientType(EnumSet.of(com.microsoft.graph.beta.models.security.RecipientType.User));
ediscoveryCaseMember.setId("c4af6f9d-37f6-43f9-9e17-601544234146");
com.microsoft.graph.models.security.EdiscoveryCaseMember result = graphClient.security().cases().ediscoveryCases().byEdiscoveryCaseId("{ediscoveryCase-id}").caseMembers().post(ediscoveryCaseMember);
const options = {
authProvider,
};
const client = Client.init(options);
const ediscoveryCaseMember = {
recipientType: 'user',
id: 'c4af6f9d-37f6-43f9-9e17-601544234146'
};
await client.api('/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/caseMembers')
.version('beta')
.post(ediscoveryCaseMember);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Security\EdiscoveryCaseMember;
use Microsoft\Graph\Beta\Generated\Models\Security\RecipientType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new EdiscoveryCaseMember();
$requestBody->setRecipientType(new RecipientType('user'));
$requestBody->setId('c4af6f9d-37f6-43f9-9e17-601544234146');
$result = $graphServiceClient->security()->cases()->ediscoveryCases()->byEdiscoveryCaseId('ediscoveryCase-id')->caseMembers()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Security
$params = @{
recipientType = "user"
id = "c4af6f9d-37f6-43f9-9e17-601544234146"
}
New-MgBetaSecurityCaseEdiscoveryCaseMember -EdiscoveryCaseId $ediscoveryCaseId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.security.ediscovery_case_member import EdiscoveryCaseMember
from msgraph_beta.generated.models.recipient_type import RecipientType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = EdiscoveryCaseMember(
recipient_type = RecipientType.User,
id = "c4af6f9d-37f6-43f9-9e17-601544234146",
)
result = await graph_client.security.cases.ediscovery_cases.by_ediscovery_case_id('ediscoveryCase-id').case_members.post(request_body)
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"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.Security;
var requestBody = new EdiscoveryCaseMember
{
RecipientType = RecipientType.RoleGroup,
Id = "b9fb4f22-5f90-47a0-b309-44fe96a959fd",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Cases.EdiscoveryCases["{ediscoveryCase-id}"].CaseMembers.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodelssecurity "github.com/microsoftgraph/msgraph-beta-sdk-go/models/security"
//other-imports
)
requestBody := graphmodelssecurity.NewEdiscoveryCaseMember()
recipientType := graphmodels.ROLEGROUP_RECIPIENTTYPE
requestBody.SetRecipientType(&recipientType)
id := "b9fb4f22-5f90-47a0-b309-44fe96a959fd"
requestBody.SetId(&id)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
caseMembers, err := graphClient.Security().Cases().EdiscoveryCases().ByEdiscoveryCaseId("ediscoveryCase-id").CaseMembers().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.models.security.EdiscoveryCaseMember ediscoveryCaseMember = new com.microsoft.graph.beta.models.security.EdiscoveryCaseMember();
ediscoveryCaseMember.setRecipientType(EnumSet.of(com.microsoft.graph.beta.models.security.RecipientType.RoleGroup));
ediscoveryCaseMember.setId("b9fb4f22-5f90-47a0-b309-44fe96a959fd");
com.microsoft.graph.models.security.EdiscoveryCaseMember result = graphClient.security().cases().ediscoveryCases().byEdiscoveryCaseId("{ediscoveryCase-id}").caseMembers().post(ediscoveryCaseMember);
const options = {
authProvider,
};
const client = Client.init(options);
const ediscoveryCaseMember = {
recipientType: 'roleGroup',
id: 'b9fb4f22-5f90-47a0-b309-44fe96a959fd'
};
await client.api('/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/caseMembers')
.version('beta')
.post(ediscoveryCaseMember);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Security\EdiscoveryCaseMember;
use Microsoft\Graph\Beta\Generated\Models\Security\RecipientType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new EdiscoveryCaseMember();
$requestBody->setRecipientType(new RecipientType('roleGroup'));
$requestBody->setId('b9fb4f22-5f90-47a0-b309-44fe96a959fd');
$result = $graphServiceClient->security()->cases()->ediscoveryCases()->byEdiscoveryCaseId('ediscoveryCase-id')->caseMembers()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Security
$params = @{
recipientType = "roleGroup"
id = "b9fb4f22-5f90-47a0-b309-44fe96a959fd"
}
New-MgBetaSecurityCaseEdiscoveryCaseMember -EdiscoveryCaseId $ediscoveryCaseId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.security.ediscovery_case_member import EdiscoveryCaseMember
from msgraph_beta.generated.models.recipient_type import RecipientType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = EdiscoveryCaseMember(
recipient_type = RecipientType.RoleGroup,
id = "b9fb4f22-5f90-47a0-b309-44fe96a959fd",
)
result = await graph_client.security.cases.ediscovery_cases.by_ediscovery_case_id('ediscoveryCase-id').case_members.post(request_body)
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": ""
}