Get-PasswordStateList.ps1
|
<#
.SYNOPSIS Gets all password lists from the API (Only those you have permissions to.) .DESCRIPTION Gets all password lists from the API (Only those you have permissions to.) .PARAMETER PasswordListID Gets the passwordlist based on ID, when omitted, gets all the passord lists .PARAMETER PasswordList The name for the PasswordList to find .PARAMETER Description The description for the PasswordList to find .PARAMETER TreePath The treepath where the PasswordList should be found .PARAMETER SiteID The siteID for the PasswordList .PARAMETER SiteLocation The sitelocation for the PasswordList .EXAMPLE PS C:\> Get-PasswordStateList .EXAMPLE PS C:\> Get-PasswordStateList -PasswordListID 3 .EXAMPLE PS C:\> Get-PasswordStateList -PasswordList 'Test' -TreePath '\TestPath\Lists' -SiteID 123 .OUTPUTS Returns the lists including their names and IDs. .NOTES 2018 - Daryl Newsholme 2019 - Jarno Colombeen #> Function Get-PasswordStateList { [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSAvoidUsingPlainTextForPassword', '', Justification = 'Not a password just an ID' )] [CmdletBinding(DefaultParameterSetName = 'ID')] Param ( [Parameter(ParameterSetName = 'ID', ValueFromPipelineByPropertyName, Position = 0)][int32]$PasswordListID, [Parameter(ParameterSetName = 'Specific', ValueFromPipelineByPropertyName, Position = 0)][string]$PasswordList, [Parameter(ParameterSetName = 'Specific', ValueFromPipelineByPropertyName, Position = 1)][string]$Description, [Parameter(ParameterSetName = 'Specific', ValueFromPipelineByPropertyName, Position = 2)][string]$TreePath, [Parameter(ParameterSetName = 'Specific', ValueFromPipelineByPropertyName, Position = 3)][int32]$SiteID, [Parameter(ParameterSetName = 'Specific', ValueFromPipelineByPropertyName, Position = 4)][string]$SiteLocation ) Process { Switch ($PSCmdlet.ParameterSetName) { 'ID'{ If (!($PSBoundParameters.ContainsKey('PasswordListID'))) { [string]$PasswordListID = '' } $uri = "/api/passwordlists/$($PasswordListID)" } 'Specific'{ $BuildURL = '?' If ($PasswordList) { $BuildURL += "PasswordList=$([System.Web.HttpUtility]::UrlEncode($PasswordList))&" } If ($Description) { $BuildURL += "Description=$([System.Web.HttpUtility]::UrlEncode($Description))&" } If ($TreePath) { $BuildURL += "TreePath=$([System.Web.HttpUtility]::UrlEncode($TreePath))&" } If ($SiteID) { $BuildURL += "SiteID=$([System.Web.HttpUtility]::UrlEncode($SiteID))&" } If ($SiteLocation) { $BuildURL += "SiteLocation=$([System.Web.HttpUtility]::UrlEncode($SiteLocation))&" } $BuildURL = $BuildURL -Replace ".$" $uri = "/api/searchpasswordlists/$($BuildURL)" } } Try { Get-PasswordStateResource -uri $uri -method GET } Catch { Throw $_.Exception } } } |