public/Get-VPASAllRotationalPlatforms.ps1
|
<#
.Synopsis GET ALL ROTATIONAL PLATFORMS CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO GET ALL ROTATIONAL PLATFORMS .LINK https://vpasmodule.com/commands/Get-VPASAllRotationalPlatforms .PARAMETER token 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 .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $AllRotationalPlatformsJSON = Get-VPASAllRotationalPlatforms .EXAMPLE $InputParameters = @{} $AllRotationalPlatformsJSON = Get-VPASAllRotationalPlatforms -InputParameters $InputParameters .OUTPUTS If successful: { "Platforms": [ ... { "general": "@{id=NewPlatform01; name=NewPlatform01; systemType=Windows; active=True; description=New platform for documentation 01; platformBaseID=WinDomain; platformType=regular}", "properties": "@{required=System.Object[]; optional=System.Object[]}", "linkedAccounts": " ", "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_hjkasd6789}", "privilegedAccessWorkflows": "@{requireDualControlPasswordAccessApproval=False; enforceCheckinCheckoutExclusiveAccess=False; enforceOnetimePasswordAccess=False}" }, { "general": "@{id=NewPlatform02; name=NewPlatform02; systemType=Windows; active=True; description=New platform for documentation 02; platformBaseID=WinDomain; platformType=regular}", "properties": "@{required=System.Object[]; optional=System.Object[]}", "linkedAccounts": " ", "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_hjkasd6789}", "privilegedAccessWorkflows": "@{requireDualControlPasswordAccessApproval=False; enforceCheckinCheckoutExclusiveAccess=False; enforceOnetimePasswordAccess=False}" }, ... ], "Total": 67 } --- $false if failed #> function Get-VPASAllRotationalPlatforms{ [OutputType('System.Object',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='InputParameters',ValueFromPipelineByPropertyName=$true,HelpMessage="Hashtable of parameters required to make API call, refer to get-help -examples for valid inputs")] [hashtable]$InputParameters, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true)] [hashtable]$token ) Begin{ $tokenval,$sessionval,$PVWA,$Header,$ISPSS,$IdentityURL,$EnableTextRecorder,$AuditTimeStamp,$NoSSL,$VaultVersion,$HideWarnings,$AuthenticatedAs,$SubDomain,$EnableTroubleshooting = Get-VPASSession -token $token $CommandName = $MyInvocation.MyCommand.Name $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType COMMAND } Process{ try{ if($PSCmdlet.ParameterSetName -eq "InputParameters"){ $KeyHash = @{ set1 = @{ AcceptableKeys = @() MandatoryKeys = @() } } $CheckSet = Test-VPASHashtableKeysHelper -InputHash $InputParameters -KeyHash $KeyHash if(!$CheckSet){ $log = Write-VPASTextRecorder -inputval "FAILED TO FIND TARGET PARAMETER SET" -token $token -LogType MISC Write-Verbose "FAILED TO FIND TARGET PARAMETER SET" Write-VPASOutput -str "FAILED TO FIND TARGET PARAMETER SET...VIEW EXAMPLES BELOW:" -type E $examples = Write-VPASExampleHelper -CommandName $CommandName return $false } else{ foreach($key in $InputParameters.Keys){ Set-Variable -Name $key -Value $InputParameters.$key } } } }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "FAILED TO RETRIEVE PLATFORM DETAILS" Write-VPASOutput -str $_ -type E return $false } try{ if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/passwordvault/api/platforms/rotationalGroups/" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/passwordvault/api/platforms/rotationalGroups/" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "GET" -token $token -LogType METHOD write-verbose "MAKING API CALL" if($sessionval){ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" -WebSession $sessionval } else{ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" } $log = Write-VPASTextRecorder -inputval $response -token $token -LogType RETURN return $response }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "UNABLE TO QUERY CYBERARK" Write-VPASOutput -str $_ -type E } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |