Passwordstate Documentation

Search for Password Lists ​

GET /api/searchpasswordlists

Searching for Password Lists can be achieved via multiple criteria, as outlined by the fields below. You can search using just one field, or multiple to further narrow down the search results.

In order to search for Password Lists, you must specify the System Wide API Key which can be found on the screen Administration -> Passwordstate Administration -> System Settings -> API tab.

  • PasswordList
  • Description
  • TreePath
  • SiteID
  • SiteLocation

Note 1: You can perform an exact match search by enclosing your search criteria in double quotes i.e. "MyFolder"

Note 2: By default, the retrieval of Passwords Lists will add one Audit record for every Password List record returned. If you wish to prevent audit records from being added, you can set the PreventAuditing parameter to true - if this parameter is omitted, the default option is false.

Powershell
PowerShell Request
# Search by Password List Name
$PasswordstateUrl = 'https://passwordstate/api/searchpasswordlists/?PasswordList=<value>'
                           
# Search by Description
$PasswordstateUrl = 'https://passwordstate/api/searchpasswordlists/?Description=<value>'

# Search by TreePath
$PasswordstateUrl = 'https://passwordstate/api/searchpasswordlists/?TreePath=<value>'

# Search by SiteID
$PasswordstateUrl = 'https://passwordstate/api/searchpasswordlists/?SiteID=<value>'

# Search by Site Location
$PasswordstateUrl = 'https://passwordstate/api/searchpasswordlists/?SiteLocation=<value>'

# Search by Password List Name and Site Location
$PasswordstateUrl = 'https://passwordstate/api/searchpasswordlists/?PasswordList=<value>&SiteLocation=<value>'

Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -Header @{ "APIKey" = "<apikey>" }
Json
# Response
HTTP/1.1 200          
[
    {
        "PasswordListID": 27,
        "PasswordList": "Web Site's",
        "Description": "Various web sites on the net",
        "ImageFileName": "website.png",
        "Guide": "",
        "AllowExport": true,
        "PrivatePasswordList": false,
        "TimeBasedAccessRequired": false,
        "NoApprovers": "1",
        "DisableNotifications": false,
        "PasswordStrengthPolicyID": 7,
        "PasswordGeneratorID": 1,
        "CodePage": "Unicode (UTF-8)",
        "PreventPasswordReuse": 5,
        "AuthenticationType": "None Required",
        "AuthenticationPerSession": false,
        "PreventExpiryDateModification": false,
        "SetExpiryDate": 0,
        "ResetExpiryDate": 0,
        "PreventDragDrop": true,
        "PreventBadPasswordUse": true,
        "ProvideAccessReason": true,
        "TreePath": "\ISP Accounts",
        "TotalPasswords": 23,
        "GeneratorName": "Default Password Generator",
        "PolicyName": "SQL Server Policy",
        "PasswordResetEnabled": false,          
        "ForcePasswordGenerator": false,
        "HidePasswords": "false:false:false",           
        "ShowGuide": false,
        "EnablePasswordResetSchedule": false,
        "PasswordResetSchedule": "05:30",
        "AddToExpiryDate": 120,
        "AddToExpiryDateInterval": "Days",
        "OneTimePasswords": false,
    }
]