vppToken resource type

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

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.

Methods

Method Return Type Description
List vppTokens vppToken collection List properties and relationships of the vppToken objects.
Get vppToken vppToken Read properties and relationships of the vppToken object.
Create vppToken vppToken Create a new vppToken object.
Delete vppToken None Deletes a vppToken.
Update vppToken vppToken Update the properties of a vppToken object.
syncLicenses action vppToken Syncs licenses associated with a specific appleVolumePurchaseProgramToken
revokeLicenses action None Revoke licenses associated with a specific appleVolumePurchaseProgramToken
getLicensesForApp function vppTokenLicenseSummary collection
syncLicenseCounts action None

Properties

Property Type Description
id String This is automatically generated when the appleVolumePurchaseProgramToken is created. It is the Key of the entity.
organizationName String The organization associated with the Apple Volume Purchase Program Token
vppTokenAccountType vppTokenAccountType The type of volume purchase program which the given Apple Volume Purchase Program Token is associated with. Possible values are: business, education. Possible values are: business, education.
appleId String The apple Id associated with the given Apple Volume Purchase Program Token.
expirationDateTime DateTimeOffset The expiration date time of the Apple Volume Purchase Program Token.
lastSyncDateTime DateTimeOffset The last time when an application sync was done with the Apple volume purchase program service using the the Apple Volume Purchase Program Token.
token String The Apple Volume Purchase Program Token string downloaded from the Apple Volume Purchase Program.
lastModifiedDateTime DateTimeOffset Last modification date time associated with the Apple Volume Purchase Program Token.
state vppTokenState Current state of the Apple Volume Purchase Program Token. Possible values are: unknown, valid, expired, invalid, assignedToExternalMDM. Possible values are: unknown, valid, expired, invalid, assignedToExternalMDM, duplicateLocationId.
tokenActionResults vppTokenActionResult collection The collection of statuses of the actions performed on the Apple Volume Purchase Program Token.
lastSyncStatus vppTokenSyncStatus Current sync status of the last application sync which was triggered using the Apple Volume Purchase Program Token. Possible values are: none, inProgress, completed, failed. Possible values are: none, inProgress, completed, failed.
automaticallyUpdateApps Boolean Whether or not apps for the VPP token will be automatically updated.
countryOrRegion String Whether or not apps for the VPP token will be automatically updated.
dataSharingConsentGranted Boolean Consent granted for data sharing with the Apple Volume Purchase Program.
displayName String An admin specified token friendly name.
locationName String Token location returned from Apple VPP.
claimTokenManagementFromExternalMdm Boolean Admin consent to allow claiming token management from external MDM.
roleScopeTagIds String collection Role Scope Tags IDs assigned to this entity.

Relationships

None

JSON Representation

Here is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.vppToken",
  "id": "String (identifier)",
  "organizationName": "String",
  "vppTokenAccountType": "String",
  "appleId": "String",
  "expirationDateTime": "String (timestamp)",
  "lastSyncDateTime": "String (timestamp)",
  "token": "String",
  "lastModifiedDateTime": "String (timestamp)",
  "state": "String",
  "tokenActionResults": [
    {
      "@odata.type": "microsoft.graph.vppTokenActionResult",
      "actionName": "String",
      "actionState": "String",
      "startDateTime": "String (timestamp)",
      "lastUpdatedDateTime": "String (timestamp)"
    }
  ],
  "lastSyncStatus": "String",
  "automaticallyUpdateApps": true,
  "countryOrRegion": "String",
  "dataSharingConsentGranted": true,
  "displayName": "String",
  "locationName": "String",
  "claimTokenManagementFromExternalMdm": true,
  "roleScopeTagIds": [
    "String"
  ]
}