Show / Hide Table of Contents

RecordsManagement.ReadWrite.All

Allow the application to create, update and delete any data from Records Management, such as configuration, labels, and policies on behalf of the signed-in user.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 D DELETE /security/labels/retentionLabels/{retentionLabelId}
V1 D DELETE /security/labels/retentionLabels/{retentionLabelId}/eventType/$ref
V1 D DELETE /security/triggers/retentionEvents/{retentionEventId}
V1 D DELETE /security/triggers/retentionEvents/{retentionEventId}/retentionEventType/$ref
V1 D DELETE /security/triggerTypes/retentionEventTypes/{retentionEventTypeId}/$ref
V1 D GET /security/labels/retentionLabels
V1 D GET /security/labels/retentionLabels/{retentionLabelId}
V1 D GET /security/labels/retentionLabels/{retentionLabelId}/eventType
V1 D GET /security/triggers/retentionEvents
V1 D GET /security/triggers/retentionEvents/{retentionEventId}
V1 D GET /security/triggers/retentionEvents/{retentionEventId}/labels/{retentionLabelId}
V1 D GET /security/triggers/retentionEvents/{retentionEventId}/retentionEventType
V1 D GET /security/triggerTypes/retentionEventTypes
V1 D GET /security/triggerTypes/retentionEventTypes/{retentionEventTypeId}
V1 D PATCH /security/labels/retentionLabels/{retentionLabelId}
V1 D PATCH /security/labels/retentionLabels/{retentionLabelId}/eventType
V1 D PATCH /security/triggers/retentionEvents/{retentionEventId}/retentionEventType
V1 D PATCH /security/triggerTypes/retentionEventTypes/{retentionEventTypeId}
V1 D POST /security/labels/retentionLabels
V1 D POST /security/triggers/retentionEvents
V1 D POST /security/triggerTypes/retentionEventTypes

Delegate Permission

Id f2833d75-a4e6-40ab-86d4-6dfe73c97605
Consent Type Admin
Display String Read and write Records Management configuration, labels, and policies
Description Allow the application to create, update and delete any data from Records Management, such as configuration, labels, and policies on behalf of the signed-in user.

Application Permission

Id eb158f57-df43-4751-8b21-b8932adb3d34
Display String Read and write Records Management configuration, labels and policies
Description Allow the application to create, update and delete any data from Records Management, such as configuration, labels, and policies without the signed in user.

Resources

dispositionReviewStage

Property Type Description
id String Unique ID for each stage.
name String Name representing each stage within a collection.
reviewersEmailAddresses String collection A collection of reviewers at each stage.
stageNumber Int32 The sequence number for each stage of the disposition review.

eventQuery

Property Type Description
queryType microsoft.graph.security.queryType Represents the type of query associated with an event. 'files' for SPO and ODB and 'messages' for EXO.The possible values are: files, messages, unknownFutureValue.
query String Represents unique identification for the query. 'Asset ID' for SharePoint Online and OneDrive for Business, 'keywords' for Exchange Online.

retentionDuration

retentionEvent

Property Type Description
createdBy microsoft.graph.identitySet The user who created the retentionEvent.
createdDateTime DateTimeOffset The date time when the retentionEvent was created.
description String Optional information about the event.
displayName String Name of the event.
eventPropagationResult microsoft.graph.security.eventPropagationResult Represents the success status of a created event and additional information.
eventQueries microsoft.graph.security.eventQueries collection Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.
retentionEventStatus microsoft.graph.security.retentionEventStatus collection Status of event propogation to the scoped locations after the event has been created.
eventTriggerDateTime DateTimeOffset Optional time when the event should be triggered.
id String Represents the unique ID of the user who created the retentionEvent. entity.
lastModifiedBy microsoft.graph.identitySet The user who last modified the retentionEvent.
lastModifiedDateTime DateTimeOffset The latest date time when the retentionEvent was modified.
lastStatusUpdateDateTime DateTimeOffset Last time the status of the event was updated.

retentionEventType

Property Type Description
createdBy microsoft.graph.identitySet The user who created the retentionEventType.
createdDateTime DateTimeOffset The date time when the retentionEventType was created.
description String Optional information about the event type.
displayName String Name of the event type.
id String Represents the unique ID of the user who created the retentionEventType. entity.
lastModifiedBy microsoft.graph.identitySet The user who last modified the retentionEventType.
lastModifiedDateTime DateTimeOffset The latest date time when the retentionEventType was modified.

retentionLabel

Property Type Description
actionAfterRetentionPeriod microsoft.graph.security.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 microsoft.graph.security.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 microsoft.graph.security.dispositionReviewStage 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 microsoft.graph.security.retentionDuration Specifies the number of days to retain the content.
retentionTrigger microsoft.graph.security.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 microsoft.graph.security.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.
In This Article
Back to top Created by merill | Submit feedback