Get-VPASAllApplications


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET ALL APPLICATIONS


Description:

USE THIS FUNCTION TO RETURN ALL APPLICATION IDS IN CYBERARK


Syntax:

Get-VPASAllApplications [-ExportToCSV] [-CSVDirectory <String>] [-token <Hashtable>] [<CommonParameters>]

Get-VPASAllApplications -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-ExportToCSV [<SwitchParameter>]
Output results to a CSV file found in AppData\Local\VPASModuleOutputs directory

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-CSVDirectory <String>
Output directory where the exported CSV file will be saved to
Default value: C:\Users\{CurrentUser}\AppData\Local\VPASModuleOutputs\ExportedCSVs

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)


Examples:

$ApplicationsJSON = Get-VPASAllApplications

$InputParameters = @{
        ExportToCSV = $true|$false
         CSVDirectory = "C:\Temp"
}
$ApplicationsJSON = Get-VPASAllApplications -InputParameters $InputParameters


Outputs:

If successful:
[
         {
                 "value": [
                         "VPasAppIDTest",
                         {
                                 "AccessPermittedFrom": 0,
                                 "AccessPermittedTo": 24,
                                 "AllowExtendedAuthenticationRestrictions": false,
                                 "AppID": "VPasAppIDTest",
                                 "BusinessOwnerEmail": "",
                                 "BusinessOwnerFName": "",
                                 "BusinessOwnerLName": "",
                                 "BusinessOwnerPhone": "",
                                 "Description": "",
                                 "Disabled": false,
                                 "ExpirationDate": null,
                                 "Location": "\\"
                         }
                 ]
         },
         {
                 "value": [
                         "VpasModuleAppIDTest",
                         {
                                 "AccessPermittedFrom": 0,
                                 "AccessPermittedTo": 24,
                                 "AllowExtendedAuthenticationRestrictions": false,
                                 "AppID": "VpasModuleAppIDTest",
                                 "BusinessOwnerEmail": "vadim.melamed@vman.com",
                                 "BusinessOwnerFName": "vadim",
                                 "BusinessOwnerLName": "melamed",
                                 "BusinessOwnerPhone": "",
                                 "Description": "Testing appID with text auditing",
                                 "Disabled": false,
                                 "ExpirationDate": null,
                                 "Location": "\\"
                         }
                 ]
         },
         {
                 "value": [
                         "AIMWebService",
                         {
                                 "AccessPermittedFrom": 0,
                                 "AccessPermittedTo": 24,
                                 "AllowExtendedAuthenticationRestrictions": false,
                                 "AppID": "AIMWebService",
                                 "BusinessOwnerEmail": "",
                                 "BusinessOwnerFName": "",
                                 "BusinessOwnerLName": "",
                                 "BusinessOwnerPhone": "",
                                 "Description": "",
                                 "Disabled": false,
                                 "ExpirationDate": null,
                                 "Location": "\\"
                         }
                 ]
         }
]

$false if failed