Get-PasswordStatePasswordHistory

NAME Get-PasswordStatePasswordHistory



SYNOPSIS

Get the history for a given password in PasswordState.





SYNTAX

Get-PasswordStatePasswordHistory [-ApiKey] <PSCredential> [-PasswordId] <Int32> [[-Endpoint] <String>] [[-Format]

<String>] [-UseV6Api] [<CommonParameters>]





DESCRIPTION

Get the history for a given password in PasswordState.





PARAMETERS

-ApiKey <PSCredential>

The API key for the password list



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PasswordId <Int32>

The Id of the password in PasswordState.



Required? true

Position? 2

Default value 0

Accept pipeline input? False

Accept wildcard characters? false



-Endpoint <String>

The Uri of your PasswordState site. (i.e. https://passwordstate.local)



Required? false

Position? 3

Default value (_GetDefault -Option 'api_endpoint')

Accept pipeline input? False

Accept wildcard characters? false



-Format <String>

The response format from PasswordState. Choose either json or xml.



Required? false

Position? 4

Default value Json

Accept pipeline input? False

Accept wildcard characters? false



-UseV6Api [<SwitchParameter>]

PasswordState versions prior to v7 did not support passing the API key in a HTTP header but instead expected

the API key to be passed as a query parameter. This switch is used for backwards compatibility with older

PasswordState versions.



Required? false

Position? named

Default value False

Accept pipeline input? False

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).



INPUTS



OUTPUTS



NOTES









-------------------------- EXAMPLE 1 --------------------------



$history = Get-PasswordStatePasswordHistory -ApiKey $key -PasswordId 1234 -Endpoint 'https://passwordstate.local'



Retrieve history for password ID 1234

-------------------------- EXAMPLE 2 --------------------------



$history = Get-PasswordStatePasswordHistory -ApiKey $key -PasswordId $id -Endpoint 'https://passwordstate.local'

-format xml



Retrieve history for password ID $id in XML format

-------------------------- EXAMPLE 3 --------------------------



Get-PasswordStatePasswordHistory -ApiKey $key -PasswordId 1234 -Endpoint 'https://passwordstate.local' | fl



Retrieve history for password ID 1234 and pipe to Format-List



RELATED LINKS