microsoft.graph.vppToken

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-graph/json-schema/microsoft-graph-microsoft-graph-vpp-token-schema.json",
  "title": "microsoft.graph.vppToken",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-graph-deviceappmanagement-vpptoken-api-openapi.yml#/components/schemas/microsoft.graph.vppToken",
  "allOf": [
    {
      "$ref": "#/$defs/microsoft.graph.entity"
    },
    {
      "title": "vppToken",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "appleId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The apple Id associated with the given Apple Volume Purchase Program Token."
        },
        "automaticallyUpdateApps": {
          "type": "boolean",
          "description": "Whether or not apps for the VPP token will be automatically updated."
        },
        "countryOrRegion": {
          "type": [
            "string",
            "null"
          ],
          "description": "Whether or not apps for the VPP token will be automatically updated."
        },
        "expirationDateTime": {
          "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
          "type": "string",
          "description": "The expiration date time of the Apple Volume Purchase Program Token.",
          "format": "date-time"
        },
        "lastModifiedDateTime": {
          "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
          "type": "string",
          "description": "Last modification date time associated with the Apple Volume Purchase Program Token.",
          "format": "date-time"
        },
        "lastSyncDateTime": {
          "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
          "type": "string",
          "description": "The last time when an application sync was done with the Apple volume purchase program service using the the Apple Volume Purchase Program Token.",
          "format": "date-time"
        },
        "lastSyncStatus": {
          "$ref": "#/$defs/microsoft.graph.vppTokenSyncStatus"
        },
        "organizationName": {
          "type": [
            "string",
            "null"
          ],
          "description": "The organization associated with the Apple Volume Purchase Program Token"
        },
        "state": {
          "$ref": "#/$defs/microsoft.graph.vppTokenState"
        },
        "token": {
          "type": [
            "string",
            "null"
          ],
          "description": "The Apple Volume Purchase Program Token string downloaded from the Apple Volume Purchase Program."
        },
        "vppTokenAccountType": {
          "$ref": "#/$defs/microsoft.graph.vppTokenAccountType"
        },
        "@odata.type": {
          "type": "string"
        }
      },
      "description": "You purchase multiple licenses for iOS apps through the Apple Volume Purchase Program for Business or Education. This involves setting up an Apple VPP account from the Apple website and uploading the Apple VPP Business or Education token to Intune. You can then synchronize your volume purchase information with Intune and track your volume-purchased app use. You can upload multiple Apple VPP Business or Education tokens."
    }
  ],
  "x-ms-discriminator-value": "#microsoft.graph.vppToken",
  "$defs": {
    "microsoft.graph.entity": {
      "title": "entity",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for an entity. Read-only."
        },
        "@odata.type": {
          "type": "string"
        }
      }
    },
    "microsoft.graph.vppTokenAccountType": {
      "title": "vppTokenAccountType",
      "enum": [
        "business",
        "education"
      ],
      "type": "string",
      "description": "Possible types of an Apple Volume Purchase Program token.",
      "x-ms-enum": {
        "name": "vppTokenAccountType",
        "modelAsString": false,
        "values": [
          {
            "value": "business",
            "description": "Apple Volume Purchase Program token associated with an business program.",
            "name": "business"
          },
          {
            "value": "education",
            "description": "Apple Volume Purchase Program token associated with an education program.",
            "name": "education"
          }
        ]
      }
    },
    "microsoft.graph.vppTokenState": {
      "title": "vppTokenState",
      "enum": [
        "unknown",
        "valid",
        "expired",
        "invalid",
        "assignedToExternalMDM"
      ],
      "type": "string",
      "description": "Possible states associated with an Apple Volume Purchase Program token.",
      "x-ms-enum": {
        "name": "vppTokenState",
        "modelAsString": false,
        "values": [
          {
            "value": "unknown",
            "description": "Default state.",
            "name": "unknown"
          },
          {
            "value": "valid",
            "description": "Token is valid.",
            "name": "valid"
          },
          {
            "value": "expired",
            "description": "Token is expired.",
            "name": "expired"
          },
          {
            "value": "invalid",
            "description": "Token is invalid.",
            "name": "invalid"
          },
          {
            "value": "assignedToExternalMDM",
            "description": "Token is managed by another MDM Service.",
            "name": "assignedToExternalMDM"
          }
        ]
      }
    },
    "microsoft.graph.vppTokenSyncStatus": {
      "title": "vppTokenSyncStatus",
      "enum": [
        "none",
        "inProgress",
        "completed",
        "failed"
      ],
      "type": "string",
      "description": "Possible sync statuses associated with an Apple Volume Purchase Program token.",
      "x-ms-enum": {
        "name": "vppTokenSyncStatus",
        "modelAsString": false,
        "values": [
          {
            "value": "none",
            "description": "Default status.",
            "name": "none"
          },
          {
            "value": "inProgress",
            "description": "Last Sync in progress.",
            "name": "inProgress"
          },
          {
            "value": "completed",
            "description": "Last Sync completed successfully.",
            "name": "completed"
          },
          {
            "value": "failed",
            "description": "Last Sync failed.",
            "name": "failed"
          }
        ]
      }
    }
  }
}