Get-PasswordStatePasswordHistory.ps1
|
<#
.SYNOPSIS Gets a password state entry historical password entries. .DESCRIPTION Gets a password state entry historical password entries.. .PARAMETER PasswordID ID value of the entry to find history for. Int32 value .PARAMETER Reason A reason which can be logged for auditing of why a password was retrieved. .EXAMPLE Get-PasswordStatePassword -PasswordID 5 Returns the test user object including password. .INPUTS PasswordID - ID of the Password entry (Integer) .OUTPUTS Returns the Object from the API as a powershell object. .NOTES Daryl Newsholme 2018 #> function Get-PasswordStatePasswordHistory { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingPlainTextForPassword', '', Justification = 'Not a password just an ID')] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalVars', '', Justification = 'Needed for backward compatability')] [CmdletBinding()] [OutputType('System.Object[]')] param ( [parameter(ValueFromPipelineByPropertyName, Position = 0)][int32]$PasswordID, [parameter(ValueFromPipelineByPropertyName, Position = 1, Mandatory = $false)][string]$reason, [parameter(ValueFromPipelineByPropertyName, Position = 2)][switch]$PreventAuditing ) begin { . "$(Get-NativePath -PathAsStringArray "$PSScriptroot","PasswordStateClass.ps1")" $output = @() } process { If ($Reason) { $headerreason = @{"Reason" = "$reason"} $parms = @{ExtraParams = @{"Headers" = $headerreason}} } Else { $parms = @{} } $uri = "/api/passwordhistory/$($PasswordID)" Switch ($PreventAuditing) { $True { $uri += "&PreventAuditing=true" } Default { } } $results = Get-PasswordStateResource -uri $uri @parms Foreach ($result in $results) { $result = [PasswordHistory]$result $result.Password = [EncryptedPassword]$result.Password $output += $result } } end { switch ($global:PasswordStateShowPasswordsPlainText) { True { $output.DecryptPassword() } } Return $output } } |