GET PLATFORM DETAILS VIA SEARCHQUERY

USE THIS FUNCTION TO GET DETAILS ABOUT A PLATFORM IN CYBERARK VIA SEARCHQUERY

Get-VPASPlatformDetailsSearch -SearchQuery <String> [-token <Hashtable>] [<CommonParameters>]

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

-SearchQuery <String>
Search string to find target resource via username, address, safe, platform, etc.
Comma separated for multiple fields, or to search all pass a blank value like so: " "

Required: true
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)

$PlatformDetailsSearchJSON = Get-VPASPlatformDetailsSearch -SearchQuery {SEARCHQUERY VALUE}

$InputParameters = @{
        SearchQuery = "VPASPlatform"
}
$PlatformDetailsSearchJSON = Get-VPASPlatformDetailsSearch -InputParameters $InputParameters

If successful:
{
         "value": [
                 {
                         "general": {
                                 "id": "WinDomainTextRecording",
                                 "name": "WinDomainTextRecording",
                                 "systemType": "Windows",
                                 "active": false,
                                 "description": "Testing API Text Recording",
                                 "platformBaseID": "WinDomain",
                                 "platformType": "regular"
                         },
                         "properties": {
                                 "required": " ",
                                 "optional": " "
                         },
                         "linkedAccounts": [
                         "@{name=LogonAccount; displayName=Logon Account}",
                         "@{name=ReconcileAccount; displayName=Reconcile Account}"
                         ],
                         "credentialsManagement": {
                                 "allowedSafes": ".*",
                                 "allowManualChange": true,
                                 "performPeriodicChange": false,
                                 "requirePasswordChangeEveryXDays": 90,
                                 "allowManualVerification": true,
                                 "performPeriodicVerification": false,
                                 "requirePasswordVerificationEveryXDays": 7,
                                 "allowManualReconciliation": true,
                                 "automaticReconcileWhenUnsynched": false
                         },
                         "sessionManagement": {
                                 "requirePrivilegedSessionMonitoringAndIsolation": true,
                                 "recordAndSaveSessionActivity": true,
                                 "PSMServerID": "PSMServer_123abc"
                         },
                         "privilegedAccessWorkflows": {
                                 "requireDualControlPasswordAccessApproval": false,
                                 "enforceCheckinCheckoutExclusiveAccess": false,
                                 "enforceOnetimePasswordAccess": false
                         }
                 },
                 {
                         "general": {
                                 "id": "WinDomain",
                                 "name": "Windows Domain Account",
                                 "systemType": "Windows",
                                 "active": true,
                                 "description": "",
                                 "platformBaseID": "WinDomain",
                                 "platformType": "regular"
                         },
                         "properties": {
                                 "required": " ",
                                 "optional": " "
                         },
                         "linkedAccounts": [
                         "@{name=LogonAccount; displayName=Logon Account}",
                         "@{name=ReconcileAccount; displayName=Reconcile Account}"
                         ],
                         "credentialsManagement": {
                                 "allowedSafes": ".*",
                                 "allowManualChange": true,
                                 "performPeriodicChange": false,
                                 "requirePasswordChangeEveryXDays": 90,
                                 "allowManualVerification": true,
                                 "performPeriodicVerification": false,
                                 "requirePasswordVerificationEveryXDays": 7,
                                 "allowManualReconciliation": true,
                                 "automaticReconcileWhenUnsynched": false
                         },
                         "sessionManagement": {
                                 "requirePrivilegedSessionMonitoringAndIsolation": true,
                                 "recordAndSaveSessionActivity": true,
                                 "PSMServerID": "PSMServer_123abc"
                         },
                         "privilegedAccessWorkflows": {
                                 "requireDualControlPasswordAccessApproval": false,
                                 "enforceCheckinCheckoutExclusiveAccess": false,
                                 "enforceOnetimePasswordAccess": false
                         }
                 }
         ]
}

$false if failed