Microsoft Purview · Schema

Microsoft Purview Retention Label

Represents a retention label for records management in Microsoft Purview. Retention labels define how long data should be retained and what happens after the retention period.

ComplianceData CatalogData ClassificationData GovernanceData Loss PreventionInformation Protection

Properties

Name Type Description
id string The unique identifier of the retention label
displayName string The display name of the retention label
descriptionForAdmins string Description visible to administrators
descriptionForUsers string Description visible to end users
isInUse boolean Whether the label is currently in use
retentionTrigger string What triggers the start of the retention period
behaviorDuringRetentionPeriod string The behavior during the retention period
actionAfterRetentionPeriod string What happens after the retention period ends
retentionDuration object The duration of the retention period
defaultRecordBehavior string The default record behavior
createdDateTime string
lastModifiedDateTime string
View JSON Schema on GitHub

JSON Schema

microsoft-purview-retention-label-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-search/microsoft-purview/json-schema/microsoft-purview-retention-label-schema.json",
  "title": "Microsoft Purview Retention Label",
  "description": "Represents a retention label for records management in Microsoft Purview. Retention labels define how long data should be retained and what happens after the retention period.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the retention label",
      "readOnly": true
    },
    "displayName": {
      "type": "string",
      "description": "The display name of the retention label"
    },
    "descriptionForAdmins": {
      "type": "string",
      "description": "Description visible to administrators"
    },
    "descriptionForUsers": {
      "type": "string",
      "description": "Description visible to end users"
    },
    "isInUse": {
      "type": "boolean",
      "description": "Whether the label is currently in use",
      "readOnly": true
    },
    "retentionTrigger": {
      "type": "string",
      "description": "What triggers the start of the retention period",
      "enum": ["dateLabeled", "dateCreated", "dateModified", "dateOfEvent"]
    },
    "behaviorDuringRetentionPeriod": {
      "type": "string",
      "description": "The behavior during the retention period",
      "enum": ["doNotRetain", "retain", "retainAsRecord", "retainAsRegulatoryRecord"]
    },
    "actionAfterRetentionPeriod": {
      "type": "string",
      "description": "What happens after the retention period ends",
      "enum": ["none", "delete", "startDispositionReview"]
    },
    "retentionDuration": {
      "type": "object",
      "description": "The duration of the retention period",
      "properties": {
        "@odata.type": {
          "type": "string"
        },
        "days": {
          "type": "integer",
          "description": "The retention duration in days"
        }
      }
    },
    "defaultRecordBehavior": {
      "type": "string",
      "description": "The default record behavior",
      "enum": ["startLocked", "startUnlocked"]
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "required": ["displayName", "behaviorDuringRetentionPeriod", "actionAfterRetentionPeriod", "retentionDuration", "retentionTrigger"]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/microsoft-purview-retention-label"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.