Capa.PowerShell.Module.SDK.VPP.psm1
|
# TODO: #246 Update and add tests <# .SYNOPSIS Gets a list of devices linked to a VPP user. .DESCRIPTION Gets a list of devices linked to a VPP user. .PARAMETER CapaSDK The CapaSDK object. .PARAMETER vppUserID The ID of the VPP user. .EXAMPLE Get-CapaDevicesLinkedToVppUser -CapaSDK $CapaSDK -vppUserID 1 .NOTES For more information, see https://capasystems.atlassian.net/wiki/spaces/CI64DOC/pages/19306247426/Get+devices+linked+to+vpp+user #> function Get-CapaDevicesLinkedToVppUser { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] $CapaSDK, [Parameter(Mandatory = $true)] [Int]$vppUserID ) $oaUnits = @() $aUnits = $CapaSDK.GetDevicesLinkedToVppUser($vppUserID) foreach ($sItem in $aUnits) { $aItem = $sItem.Split(';') $oaUnits += [pscustomobject]@{ Name = $aItem[0]; Created = $aItem[1]; LastExecuted = $aItem[2]; Status = $aItem[3]; Description = $aItem[4]; GUID = $aItem[5]; ID = $aItem[7]; TypeName = $aItem[8]; UUID = $aItem[9]; IsMobileDevice = $aItem[10]; location = $aItem[11] } } Return $oaUnits } # TODO: #247 Update and add tests <# .SYNOPSIS Gets a list of users linked to a VPP user. .DESCRIPTION Gets a list of users linked to a vpp user, including inventory variables like full name and emails. .PARAMETER CapaSDK The CapaSDK object. .PARAMETER VppUserID The ID of the VPP user. .EXAMPLE Get-CapaUsersLinkedToVppUser -CapaSDK $CapaSDK -VppUserID 1 .NOTES For more information, see https://capasystems.atlassian.net/wiki/spaces/CI64DOC/pages/19306247612/Get+users+linked+to+vpp+user #> function Get-CapaUsersLinkedToVppUser { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] $CapaSDK, [Parameter(Mandatory = $true)] [int]$VppUserID ) $oaUnits = @() $aUnits = $CapaSDK.GetUsersLinkedToVppUser($VppUserID) foreach ($sItem in $aUnits) { $aItem = $sItem.Split(';') $oaUnits += [pscustomobject]@{ Name = $aItem[0]; Created = $aItem[1]; LastExecuted = $aItem[2]; Status = $aItem[3]; Description = $aItem[4]; GUID = $aItem[5]; ID = $aItem[7]; TypeName = $aItem[8]; UUID = $aItem[9]; Location = $aItem[10]; FullName = $aItem[11]; EmailPrimary = $aItem[12]; EmailSecondary = $aItem[13]; EmailTertiary = $aItem[14] } } Return $oaUnits } # TODO: #248 Update and add tests <# .SYNOPSIS Gets a list of all VPP programs. .DESCRIPTION Gets a list of all VPP programs. .PARAMETER CapaSDK The CapaSDK object. .EXAMPLE Get-CapaVppPrograms -CapaSDK $CapaSDK .NOTES For more information, see https://capasystems.atlassian.net/wiki/spaces/CI64DOC/pages/19306247798/Get+vpp+programs #> function Get-CapaVppPrograms { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] $CapaSDK ) $oaUnits = @() $aUnits = $CapaSDK.GetVppPrograms() foreach ($sItem in $aUnits) { $aItem = $sItem.Split(';') $oaUnits += [pscustomobject]@{ ID = $aItem[0]; Name = $aItem[1]; OrganisationName = $aItem[2]; Email = $aItem[3]; ExpireDate = $aItem[4]; GUID = $aItem[5]; Description = $aItem[7] } } Return $oaUnits } # TODO: #249 Update and add tests <# .SYNOPSIS Gets a list of all VPP users. .DESCRIPTION Gets a list of all VPP users, if VppProgramID is specified, only VPP users for the specified program will be returned. .PARAMETER CapaSDK The CapaSDK object. .PARAMETER VppProgramID A description of the VppProgramID parameter. .EXAMPLE Get-CapaVppUsers -CapaSDK $CapaSDK .EXAMPLE Get-CapaVppUsers -CapaSDK $CapaSDK -VppProgramID 1 .NOTES For more information, see https://capasystems.atlassian.net/wiki/spaces/CI64DOC/pages/19306247808/Get+vpp+users And https://capasystems.atlassian.net/wiki/spaces/CI64DOC/pages/19306247818/Get+vpp+users+all #> function Get-CapaVppUsers { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] $CapaSDK, [int]$VppProgramID = '' ) $oaUnits = @() if ($VppProgramID -eq '') { $aUnits = $CapaSDK.GetVppUsersAll() } Else { $aUnits = $CapaSDK.GetVppUsers($VppProgramID) } foreach ($sItem in $aUnits) { $aItem = $sItem.Split(';') $oaUnits += [pscustomobject]@{ ID = $aItem[0]; Status = $aItem[1]; Updated = $aItem[2]; UserID = $aItem[3]; ClientUserIDStr = $aItem[4]; Name = $aItem[5]; Description = $aItem[7]; Email = $aItem[8]; ItsIdHash = $aItem[9]; InviteUrl = $aItem[10]; InviteCode = $aItem[11]; VPPAccountID = $aItem[12]; GUID = $aItem[13] } } Return $oaUnits } # TODO: #250 Update and add tests <# .SYNOPSIS 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. .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. .PARAMETER CapaSDK The CapaSDK object. .PARAMETER VppProgramID The VPP user will be created in the program with the specified id. .PARAMETER UnitID The id of the iOS device which should receive an invitation. .PARAMETER UserFullName The fullname of the vpp user being created. .PARAMETER UserEmailName The email of the vpp user being created. .PARAMETER UserDescription The description of the vpp user being created. .EXAMPLE Invite-CapaUnitToVppProgram -CapaSDK $CapaSDK -VppProgramID 1 -UnitID 1 -UserFullName 'Test User' -UserEmailName 'Test@test.com' -UserDescription 'Test User' .NOTES For more information, see https://capasystems.atlassian.net/wiki/spaces/CI64DOC/pages/19306247828/Invite+unit+to+vpp #> function Invite-CapaUnitToVppProgram { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] $CapaSDK, [Parameter(Mandatory = $true)] [int]$VppProgramID, [Parameter(Mandatory = $true)] [int]$UnitID, [Parameter(Mandatory = $true)] [String]$UserFullName, [Parameter(Mandatory = $true)] [String]$UserEmailName, [Parameter(Mandatory = $true)] [String]$UserDescription ) $value = $CapaSDK.InviteUnitToVppProgram($VppProgramID, $UnitID, $UserFullName, $UserEmailName, $UserDescription) return $value } |