Page tree
Skip to end of metadata
Go to start of metadata

Description

Creates a VPP user at Apple where an invitation URL is generated. This invitation is then sent to the device where the user will have the option to accept or decline.

If the user accepts the invitation, its Apple ID will be linked to the VPP user at Apple, which can be seen in the system after the next synchronization cycle.

There are a few requirements for the operation to succeed.

  • The device must be running iOS8 or higher.
  • The device should not already be enrolled in the Volume Purchase Program specified.
  • If an invitation previously sent to the device was not accepted, a VPP user will already exist at Apple. In order to avoid creating multiple VPP users, the system will reuse that original invitation and send it to the device again.

Syntax

InviteUnitToVppProgram(ByVal vppProgramID As Integer, ByVal unitID As Integer, ByVal userFullName As String, ByVal userEmail As String, ByVal userDescription As String) As Boolean

Parameters

vppProgramID (Integer)

The VPP user will be created in the program with the specified id.

unitID (Integer)

The id of the iOS device which should receive an invitation.

userFullName (String)

The fullname of the vpp user being created.

userEmailName (String)

The email of the vpp user being created.

userDescription (String)

The description of the vpp user being created.

Return Value

Boolean. Returns true if the VPP user is created and the invitation is sent, or a previous invitation to the same device could be sent again.

Example

VBScript
Set oCMS = CreateObject("CapaInstaller.SDK") 
wscript.echo oCMS.SetDefaultManagementPoint("1") 
wscript.echo oCMS.InviteUnitToVppProgram(2,45,"John Smith","js@corp.com","Sales dep.") 
  • No labels