Skip to content

ediscovery-custodian.md

Latest commit

 

History

History
93 lines (76 loc) · 5.26 KB

ediscovery-custodian.md

File metadata and controls

93 lines (76 loc) · 5.26 KB
title custodian resource type
description In the context of eDiscovery, represents a user and all of their digital assets, such as email and documents.
author mahage-msft
ms.localizationpriority medium
ms.subservice ediscovery
doc_type resourcePageType
ms.date 07/22/2024

custodian resource type

Namespace: microsoft.graph.ediscovery

[!INCLUDE beta-disclaimer]

[!INCLUDE ediscovery-deprecation]

In the context of eDiscovery, represents a user and all of their digital assets, such as email and documents.

Methods

Method Return type Description
List microsoft.graph.ediscovery.custodian collection Get a list of custodian objects and their properties.
Create microsoft.graph.ediscovery.custodian Create a new custodian object.
Get microsoft.graph.ediscovery.custodian Read the properties and relationships of a custodian object.
Update microsoft.graph.ediscovery.custodian Update the properties of a custodian object.
Release None Release a custodian from a case.
Activate None Reactivate a custodian that has been released from a case and make them part of the case again.
List site sources microsoft.graph.ediscovery.siteSource collection Get the siteSource resources associated with the custodian.
Create site sources microsoft.graph.ediscovery.siteSource Create a new siteSource object.
List unified group sources microsoft.graph.ediscovery.unifiedGroupSource collection Get the list of unifiedGroupSource resources associated with the custodian.
Create unified group sources microsoft.graph.ediscovery.unifiedGroupSource Create a new unifiedGroupSource object.
List user sources microsoft.graph.ediscovery.userSource collection Get the list of userSource resources associated with the custodian.
Create user sources microsoft.graph.ediscovery.userSource Create a new userSource object.

Properties

Property Type Description
acknowledgedDateTime DateTimeOffset Date and time the custodian acknowledged a hold notification.
applyHoldToSources Boolean Identifies whether a custodian's sources were placed on hold during creation.
createdDateTime DateTimeOffset Date and time when the custodian was added to the case.
displayName String Display name of the custodian.
email String Email address of the custodian.
id String The ID for the custodian in the specified case. Read-only.
lastModifiedDateTime DateTimeOffset Date and time the custodian object was last modified
releasedDateTime DateTimeOffset Date and time the custodian was released from the case.
status microsoft.graph.ediscovery.custodianStatus Status of the custodian. The possible values are: active, released.

custodianStatus values

Member Description
active Custodian is an active part of the case.
released Custodian is released from the case.

Relationships

Relationship Type Description
siteSources microsoft.graph.ediscovery.siteSource collection Data source entity for SharePoint sites associated with the custodian.
unifiedGroupSources microsoft.graph.ediscovery.unifiedGroupSource collection Data source entity for groups associated with the custodian.
userSources microsoft.graph.ediscovery.userSource collection Data source entity for a the custodian. This is the container for a custodian's mailbox and OneDrive for Business site.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.ediscovery.custodian",
  "email": "String",
  "applyHoldToSources": "Boolean",
  "status": "String",
  "createdDateTime": "String (timestamp)",
  "lastModifiedDateTime": "String (timestamp)",
  "releasedDateTime": "String (timestamp)",
  "acknowledgedDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "displayName": "String"
}