Passwordstate Documentation

Retrieving all Shared Password Lists ​

You can retrieve a list of all Shared Password Lists by using the System Wide API Key and a simple GET request.

Note: 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
$PasswordstateUrl = 'https://passwordstate/api/passwordlists/'
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,
    },
    {
        ...
    },
    {
        ...
    }
]