Microsoft Graph · Schema

retentionLabelSettings

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks

Properties

Name Type Description
behaviorDuringRetentionPeriod object Describes the item behavior during retention period. The possible values are: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue. Read-only.
isContentUpdateAllowed boolean Specifies whether updates to document content are allowed. Read-only.
isDeleteAllowed boolean Specifies whether the document deletion is allowed. Read-only.
isLabelUpdateAllowed boolean Specifies whether you're allowed to change the retention label on the document. Read-only.
isMetadataUpdateAllowed boolean Specifies whether updates to the item metadata (for example, the Title field) are blocked. Read-only.
isRecordLocked boolean Specifies whether the item is locked. Read-write.
@odata.type string
View JSON Schema on GitHub

JSON Schema

microsoft-graph-microsoftgraphretentionlabelsettings-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.retentionLabelSettings",
  "title": "retentionLabelSettings",
  "required": [
    "@odata.type"
  ],
  "type": "object",
  "properties": {
    "behaviorDuringRetentionPeriod": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/microsoft.graph.security.behaviorDuringRetentionPeriod"
        },
        {
          "type": "object",
          "nullable": true
        }
      ],
      "description": "Describes the item behavior during retention period. The possible values are: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue. Read-only."
    },
    "isContentUpdateAllowed": {
      "type": "boolean",
      "description": "Specifies whether updates to document content are allowed. Read-only.",
      "nullable": true
    },
    "isDeleteAllowed": {
      "type": "boolean",
      "description": "Specifies whether the document deletion is allowed. Read-only.",
      "nullable": true
    },
    "isLabelUpdateAllowed": {
      "type": "boolean",
      "description": "Specifies whether you're allowed to change the retention label on the document. Read-only.",
      "nullable": true
    },
    "isMetadataUpdateAllowed": {
      "type": "boolean",
      "description": "Specifies whether updates to the item metadata (for example, the Title field) are blocked. Read-only.",
      "nullable": true
    },
    "isRecordLocked": {
      "type": "boolean",
      "description": "Specifies whether the item is locked. Read-write.",
      "nullable": true
    },
    "@odata.type": {
      "type": "string"
    }
  }
}