public/Get-VPASDPASettings.ps1
|
<#
.Synopsis GET DPA SETTINGS CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO RETRIEVE ALL DPA SETTINGS .LINK https://vpasmodule.com/commands/Get-VPASDPASettings .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 $AllSettings = Get-VPASDPASettings .EXAMPLE $InputParameters = @{} $AllSettings = Get-VPASDPASettings -InputParameters $InputParameters .OUTPUTS If successful: { "mfaCaching": { "isMfaCachingEnabled": true, "keyExpirationTimeSec": 3600 }, "sshMfaCaching": { "isMfaCachingEnabled": false, "keyExpirationTimeSec": 3600 }, "rdpMfaCaching": { "isMfaCachingEnabled": true, "keyExpirationTimeSec": 60, "clientIpEnforced": true, "tokenUsageCount": 0 }, "rdpTokenMfaCaching": { "isMfaCachingEnabled": false, "keyExpirationTimeSec": 3600, "clientIpEnforced": true, "tokenUsageCount": 0 }, "adbMfaCaching": { "isMfaCachingEnabled": true, "keyExpirationTimeSec": 7200, "clientIpEnforced": true, "tokenUsageCount": 0 }, "k8sMfaCaching": { "keyExpirationTimeSec": 7200, "clientIpEnforced": true, "tokenUsageCount": 0 }, "sshCommandAudit": { "isCommandParsingForAuditEnabled": true, "shellPromptForAudit": "(.*)[\u003e#\\$]$" }, "standingAccess": { "standingAccessAvailable": true, "sessionMaxDuration": 120, "sessionIdleTime": 10, "fingerprintValidation": true, "sshStandingAccessAvailable": true, "rdpStandingAccessAvailable": true, "adbStandingAccessAvailable": true }, "rdpFileTransfer": { "enabled": true }, "certificateValidation": { "enabled": false }, "rdpKeyboardLayout": { "layout": "en-us-qwerty" }, "rdpRecording": { "enabled": true }, "logonSequence": { "logonSequence": "\\[.*\\@.*~]\\$\u003eexec su - {Username}\nPassword:\u003e{Password}" } } --- $false if failed #> function Get-VPASDPASettings{ [OutputType('System.Collections.Hashtable',[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 DPA SETTINGS" Write-VPASOutput -str $_ -type E return $false } try{ if($SubDomain -eq "N/A"){ Write-VPASOutput -str "SelfHosted + PriviledgeCloud Standard solutions do not support this API Call, returning false" -type E $log = Write-VPASTextRecorder -inputval "SelfHosted + PrivilegeCloud Standard solutions do not support this API Call, returning false" -token $token -LogType MISC $log = Write-VPASTextRecorder -inputval $false -token $token -LogType RETURN return $false } write-verbose "MAKING API CALL TO CYBERARK" $uri = "https://$SubDomain.dpa.cyberark.cloud/api/settings" Write-Verbose "CONSTRUCTING URI: $uri" $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "GET" -token $token -LogType METHOD 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 RETURNARRAY Write-Verbose "RETURNING JSON OBJECT" 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 "FAILED TO RETRIEVE DPA SETTINGS" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |