public/Reset-VPASEPVUserPassword.ps1
|
<#
.Synopsis RESET EPV USER PASSWORD CREATED BY: Vadim Melamed, EMAIL: vmelamed5@gmail.com .DESCRIPTION USE THIS FUNCTION TO RESET THE PASSWORD OF AN EPV USER .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 LookupBy Which method will be used to query for the target EPVUser, via Username or UserID Possible values: Username, UserID .PARAMETER LookupVal Target searchquery string .PARAMETER NewPassword New temporary password that will be applied to the target EPVUser .EXAMPLE $ResetEPVUserPasswordStatus = Reset-VPASEPVUserPassword -LookupBy Username -LookupVal {USERNAME VALUE} -NewPassword {NEWPASSWORD VALUE} .EXAMPLE $ResetEPVUserPasswordStatus = Reset-VPASEPVUserPassword -LookupBy UserID -LookupVal {USERID VALUE} -NewPassword {NEWPASSWORD VALUE} .OUTPUTS $true if successful $false if failed #> function Reset-VPASEPVUserPassword{ [OutputType([bool])] [CmdletBinding()] Param( [Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true,HelpMessage="Enter search method (Username, UserID)",Position=0)] [ValidateSet('Username','UserID')] [String]$LookupBy, [Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true,HelpMessage="Enter search value to query for target EPVUser",Position=1)] [String]$LookupVal, [Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true,HelpMessage="Enter new temporary password for target EPVUser",Position=2)] [String]$NewPassword, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=3)] [hashtable]$token ) Begin{ $tokenval,$sessionval,$PVWA,$Header,$ISPSS,$IdentityURL,$EnableTextRecorder,$AuditTimeStamp,$NoSSL,$VaultVersion = Get-VPASSession -token $token $CommandName = $MyInvocation.MyCommand.Name $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType COMMAND } Process{ Write-Verbose "SUCCESSFULLY PARSED PVWA VALUE" Write-Verbose "SUCCESSFULLY PARSED TOKEN VALUE" Write-Verbose "SUCCESSFULLY PARSED LOOKUPBY VALUE" Write-Verbose "SUCCESSFULLY PARSED LOOKUPVAL VALUE" Write-Verbose "SUCCESSFULLY PARSED NEWPASSWORD VALUE" try{ if($LookupBy -eq "Username"){ Write-Verbose "CONSTRUCTING SEARCH STRING TO QUERY CYBERARK" $searchQuery = "$LookupVal" Write-Verbose "INVOKING HELPER FUNCTION TO RETRIEVE USERID" $UserID = Get-VPASEPVUserIDHelper -token $token -username $LookupVal } elseif($LookupBy -eq "UserID"){ Write-Verbose "SUPPLIED USERID, SKIPPING HELPER FUNCTION" $UserID = $LookupVal } $UserIDint = [int]$UserID write-verbose "CONVERTED USERID FROM TYPE STRING TO TYPE INT" $params = @{ id = $UserIDint newPassword = $NewPassword } | ConvertTo-Json $OutputParams = @{ id = $UserIDint newPassword = "{NewCredentials}" } $log = Write-VPASTextRecorder -inputval $OutputParams -token $token -LogType PARAMS Write-Verbose "SUCCESSFULLY SETUP PARAMETERS FOR API CALL" if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/PasswordVault/api/Users/$UserID/ResetPassword" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/PasswordVault/api/Users/$UserID/ResetPassword" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "POST" -token $token -LogType METHOD Write-Verbose "MAKING API CALL TO CYBERARK" if($sessionval){ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method POST -Body $params -ContentType "application/json" -WebSession $sessionval } else{ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method POST -Body $params -ContentType "application/json" } $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: TRUE" -token $token -LogType MISC Write-Verbose "SUCCESSFULLY RESET PASSWORD OF $LookupBy = $LookupVal" return $true }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 RESET PASSWORD OF EPVUSER VIA $LookupBy : $LookupVal" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |