< Back

Get-PasswordStateAllLists

Sat Jan 18, 2020 6:38 pm

NAME Get-PasswordStateAllLists



SYNOPSIS

Get all shared password lists in PasswordState.





SYNTAX

Get-PasswordStateAllLists [-SystemApiKey] <PSCredential> [[-Endpoint] <String>] [[-Format] <String>] [-UseV6Api]

[<CommonParameters>]





DESCRIPTION

Get all shared password lists in PasswordState.





PARAMETERS

-SystemApiKey <PSCredential>

The system API key for PasswordState.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Endpoint <String>

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



Required? false

Position? 2

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? 3

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 system API key

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



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



Get all password lists using system API key in XML format



RELATED LINKS