Get-PasswordStateList

NAME Get-PasswordStateList



SYNOPSIS

Get a specific password list in PasswordState.





SYNTAX

Get-PasswordStateList [-ApiKey] <PSCredential> [-PasswordListId] <Int32> [[-Endpoint] <String>] [[-Format]

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





DESCRIPTION

Get a specific password list in PasswordState.





PARAMETERS

-ApiKey <PSCredential>

The API key for this password list.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PasswordListId <Int32>

The Id of the password list 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 --------------------------



$lists = Get-PasswordStateList -SystemApiKey $sysKey -Endpoint 'https://passwordstate.local'



Get all password lists using the system API key

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



$lists = Get-PasswordStateList -SystemApiKey $sysKey -Endpoint 'https://passwordstate.local' -format xml



Get all password lists using the system API key and in XML format

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



Get-PasswordStateList -SystemApiKey $key -Endpoint 'https://passwordstate.local' | fl



Get all password lists using the system API key and pipe to Format-List



RELATED LINKS