retentionLabel resource type



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.

Represents how customers can manage their data, including whether and for how long to retain or delete it.


Method Return type Description
List retentionLabels collection Get a list of the retentionLabel objects and their properties.
Create retentionLabel Create a new retentionLabel object.
Get retentionLabel Read the properties and relationships of a retentionLabel object.
Update retentionLabel Update the properties of a retentionLabel object.
Delete retentionLabel None Delete a retentionLabel object.
List retentionEventType collection Get the retentionEventType resources from the exapnd eventType navigation property.
Add retentionEventType Add eventType by adding the relevant odata property when creating a label.


Property Type Description
actionAfterRetentionPeriod Specifies the action to take on a document with this label applied during the retention period. The possible values are: none, delete, startDispositionReview, unknownFutureValue.
behaviorDuringRetentionPeriod Specifies how the behavior of a document with this label should be during the retention period. The possible values are: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue.
createdBy microsoft.graph.identitySet Represents the user who created the retentionLabel.
createdDateTime DateTimeOffset Represents the date and time in which the retentionLabel is created.
descriptionForAdmins String Provides label information for the admin. Optional.
descriptionForUsers String Provides the label information for the user. Optional.
displayName String Unique string that defines a label name.
dispositionReviewStages collection Review stages during which reviewers are notified to determine whether a document must be deleted or retained.
id String Unique ID of the retentionLabel. entity.
isInUse Boolean Specifies whether the label is currently being used.
lastModifiedBy microsoft.graph.identitySet The user who last modified the retentionLabel.
lastModifiedDateTime DateTimeOffset The latest date time when the retentionLabel was modified.
retentionDuration Specifies the number of days to retain the content.
retentionTrigger Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: dateLabeled, dateCreated, dateModified, dateOfEvent, unknownFutureValue.
defaultRecordBehavior Specifies the locked or unlocked state of a record label when it is created.The possible values are: startLocked, startUnlocked, unknownFutureValue.
labelToBeApplied String Specifies the replacement label to be applied automatically after the retention period of the current label ends.


Relationship Type Description
dispositionReviewStages collection When action at the end of retention is chosen as 'dispositionReview', dispositionReviewStages specifies a sequential set of stages with at least one reviewer in each stage.
eventType Represents the type associated with a retention event..

JSON representation

The following is a JSON representation of the resource.

  "@odata.type": "",
  "id": "String (identifier)",
  "displayName": "String",
  "behaviorDuringRetentionPeriod": "String",
  "actionAfterRetentionPeriod": "String",
  "retentionTrigger": "String",
  "retentionDuration": {
    "@odata.type": ""
  "isInUse": "Boolean",
  "descriptionForAdmins": "String",
  "descriptionForUsers": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  "createdDateTime": "String (timestamp)",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  "lastModifiedDateTime": "String (timestamp)",
  "labelToBeApplied": "String",
  "defaultRecordBehavior": "String"