Passwordstate Documentation

Password Strength Policies ​

You can retrieve all or search the Password Strength Policies with a simple GET request. You must have the Password Strength Policy Security Administrator's role to retrieve these.

Retrieve all Password Strength Policies

GET /winapi/passwordstrength

Powershell
# PowerShell Request
$PasswordstateUrl = 'https://passwordstate/winapi/passwordstrength'
Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -UseDefaultCredentials
Json
# Response
HTTP/1.1 200 
[
{
 "PasswordStrengthPolicyID": 1,
 "PolicyName": "Default Policy",
 "PolicyDescription": "Default policy if no specific policy is set for a Password List",
 "MinimumLowerCaseCharacters": 1,
 "MinimumNumericCharacters": 1,
 "MinimumSymbolCharacters": 1,
 "MinimumUpperCaseCharacters": 1,
 "PreferredPasswordLength": 16,
 "RequiresUpperAndLowerCase": true,
 "CalculationWeightings": "50;15;15;20",
 "PasswordStrengthCompliance": 4,
 "ComplianceMandatory": false
},
{
 "PasswordStrengthPolicyID": 2,
 "PolicyName": "Door Tumbler Locks",
 "PolicyDescription": "Use for door access tumblers which is, just numbers",
 "MinimumLowerCaseCharacters": 0,
 "MinimumNumericCharacters": 4,
 "MinimumSymbolCharacters": 0,
 "MinimumUpperCaseCharacters": 0,
 "PreferredPasswordLength": 4,
 "RequiresUpperAndLowerCase": false,
 "CalculationWeightings": "0;100;0;0",
 "PasswordStrengthCompliance": 3,
 "ComplianceMandatory": false
}
{
 "PasswordStrengthPolicyID": 3,
 "PolicyName": "SQL Server Policy",
 "PolicyDescription": "Used for all SQL Server Accounts",
 "MinimumLowerCaseCharacters": 1,
 "MinimumNumericCharacters": 1,
 "MinimumSymbolCharacters": 1,
 "MinimumUpperCaseCharacters": 1,
 "PreferredPasswordLength": 8,
 "RequiresUpperAndLowerCase": true,
 "CalculationWeightings": "50;15;15;20",
 "PasswordStrengthCompliance": 4,
 "ComplianceMandatory": true
}
]

Search Password Strength Policies

GET /winapi/passwordstrength/?search=default

Note: The search only considers the Policy Name and Description fields.

Powershell
# PowerShell Request
$PasswordstateUrl = 'https://passwordstate/winapi/passwordstrength/?search=default'
Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -UseDefaultCredentials
Json
# Response
HTTP/1.1 200          
[
 {
 "PasswordStrengthPolicyID": 1,
 "PolicyName": "Default Policy",
 "PolicyDescription": "Default policy if no specific policy is set for a Password List",
 "MinimumLowerCaseCharacters": 1,
 "MinimumNumericCharacters": 1,
 "MinimumSymbolCharacters": 1,
 "MinimumUpperCaseCharacters": 1,
 "PreferredPasswordLength": 16,
 "RequiresUpperAndLowerCase": true,
 "CalculationWeightings": "50;15;15;20",
 "PasswordStrengthCompliance": 4,
 "ComplianceMandatory": false
}
]