Edit

ediscoverySearch: purgeData

  • Article

Namespace: microsoft.graph.security

Delete Microsoft Teams messages contained in an eDiscovery search.

Note: This request purges Teams data only. It does not purge other types of data such as mailbox items.

You can collect and purge the following categories of Teams content:

  • Teams 1:1 chats - Chat messages, posts, and attachments shared in a Teams conversation between two people. Teams 1:1 chats are also called conversations.
  • Teams group chats - Chat messages, posts, and attachments shared in a Teams conversation between three or more people. Also called 1:N chats or group conversations.
  • Teams channels - Chat messages, posts, replies, and attachments shared in a standard Teams channel.
  • Private channels - Message posts, replies, and attachments shared in a private Teams channel.
  • Shared channels - Message posts, replies, and attachments shared in a shared Teams channel.

For more information about purging Teams messages, see:

This API is supported in the following national cloud deployments.

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

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) eDiscovery.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Not supported.

HTTP request

POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/searches/{ediscoverySearchId}/purgeData

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

In the request body, supply a JSON representation of the parameters.

The following table shows the parameters that can be used with this action.

Parameter Type Description
purgeType microsoft.graph.security.purgeType Options that control whether the action is soft delete or hard delete. Possible values are recoverable, permanentlydeleted, unknownFutureValue.
purgeAreas microsoft.graph.security.purgeAreas Option to define the locations to be in scope of the purge action. Possible values are: mailboxes, teamsMessages, unknownFutureValue.

Response

If successful, this action returns a 202 Accepted response code.

If the purge data operation is started successfully, this action returns a 202 Accepted response code. The response will also contain a Location header, which contains the location of the Purge data operation that was created to commit the purge. To check the status of the purge data operation, make a GET request to the location URL.

Examples

Request

The following is an example of a request.

POST https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/searches/c61a5860-d634-4d14-aea7-d82b6f4eb7af/purgeData

{

}

Response

The following is an example of the response.

HTTP/1.1 202 Accepted