Skip to content

ediscovery-sourcecollection-purgedata.md

Latest commit

 

History

History
122 lines (89 loc) · 5.32 KB

ediscovery-sourcecollection-purgedata.md

File metadata and controls

122 lines (89 loc) · 5.32 KB
title sourceCollection: purgeData
description Use the purge data method to delete sensitive misplaced Microsoft Teams messages in a sourceCollection.
author mahage-msft
ms.localizationpriority medium
ms.subservice ediscovery
doc_type apiPageType
ms.date 06/10/2024

sourceCollection: purgeData

Namespace: microsoft.graph.ediscovery

[!INCLUDE beta-disclaimer]

[!INCLUDE ediscovery-deprecation]

Permanently delete Microsoft Teams messages contained in a sourceCollection.

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:

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

HTTP request

POST /compliance/ediscovery/cases/{caseId}/sourceCollections/{sourceCollectionId}/purgeData

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

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. When the request successfully completes, the status will change to succeeded.

Examples

Request

HTTP

POST https://graph.microsoft.com/beta/compliance/ediscovery/cases/{caseId}/sourceCollections/{sourceCollectionId}/purgeData

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

HTTP/1.1 202 Accepted