Passwordstate Documentation

Password Generator Policies ​

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

Retrieve all Password Generator Policies

GET /winapi/passwordgenerator

Powershell
# PowerShell Request
$PasswordstateUrl = 'https://passwordstate/winapi/passwordgenerator'
Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -UseDefaultCredentials
Json
# Response
HTTP/1.1 200          
[
{
 "PasswordGeneratorID": 1,
 "GeneratorName": "Default Password Generator",
 "GeneratorDescription": "Default Password Generator with medium complexity of alphanumeric characters",
 "IncludeAlphaSpecial": true,
 "IncludeWordPhrases": false,
 "MinLength": 20,
 "MaxLength": 20,
 "LowerCaseChars": true,
 "UpperCaseChars": true,
 "NumericChars": true,
 "HigherAlphaRatio": true,
 "AmbiguousChars": false,
 "SpecialChars": false,
 "BracketChars": false,
 "SpecialCharsText": "!@#$%^&*+/=_-",
 "BracketCharsText": "[](){}<>",
 "NumberOfWords": 1,
 "MaximumWordLength": 7,
 "PrefixAppendWords": "P",
 "SeparateWordsWith": "D",
 "ExcludeChars": "",
 "GeneratePattern": false,
 "Pattern": ""
},
{
 "PasswordGeneratorID": 2,
 "GeneratorName": "SQL Password Generator",
 "GeneratorDescription": "For SQL Server Password Lists only",
 "IncludeAlphaSpecial": true,
 "IncludeWordPhrases": false,
 "MinLength": 15,
 "MaxLength": 20,
 "LowerCaseChars": true,
 "UpperCaseChars": true,
 "NumericChars": true,
 "HigherAlphaRatio": true,
 "AmbiguousChars": true,
 "SpecialChars": true,
 "BracketChars": false,
 "SpecialCharsText": "!@#$%^&*+/=_-",
 "BracketCharsText": "[](){}<>",
 "NumberOfWords": 1,
 "MaximumWordLength": 10,
 "PrefixAppendWords": "P",
 "SeparateWordsWith": "D",
 "ExcludeChars": "",
 "GeneratePattern": false,
 "Pattern": ""
}
{
 "PasswordGeneratorID": 5,
 "GeneratorName": "Just Numbers",
 "GeneratorDescription": "Nothing but numbers for this one",
 "IncludeAlphaSpecial": true,
 "IncludeWordPhrases": false,
 "MinLength": 5,
 "MaxLength": 7,
 "LowerCaseChars": false,
 "UpperCaseChars": false,
 "NumericChars": true,
 "HigherAlphaRatio": true,
 "AmbiguousChars": false,
 "SpecialChars": false,
 "BracketChars": false,
 "SpecialCharsText": "!@#$%^&*+/=_-",
 "BracketCharsText": "[](){}<>",
 "NumberOfWords": 1,
 "MaximumWordLength": 7,
 "PrefixAppendWords": "P",
 "SeparateWordsWith": "D",
 "ExcludeChars": "",
 "GeneratePattern": false,
 "Pattern": ""
}
]

Search Password Generator Policies

GET /winapi/passwordgenerator/?search=default

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

Powershell
# PowerShell Request
$PasswordstateUrl = 'https://passwordstate/winapi/passwordgenerator/?search=default'
Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -UseDefaultCredentials
Json
# Response
HTTP/1.1 200          
[
{
 "PasswordGeneratorID": 1,
 "GeneratorName": "Default Password Generator",
 "GeneratorDescription": "Default Password Generator with medium complexity of alphanumeric characters",
 "IncludeAlphaSpecial": true,
 "IncludeWordPhrases": false,
 "MinLength": 20,
 "MaxLength": 20,
 "LowerCaseChars": true,
 "UpperCaseChars": true,
 "NumericChars": true,
 "HigherAlphaRatio": true,
 "AmbiguousChars": false,
 "SpecialChars": false,
 "BracketChars": false,
 "SpecialCharsText": "!@#$%^&*+/=_-",
 "BracketCharsText": "[](){}<>",
 "NumberOfWords": 1,
 "MaximumWordLength": 7,
 "PrefixAppendWords": "P",
 "SeparateWordsWith": "D",
 "ExcludeChars": "",
 "GeneratePattern": false,
 "Pattern": ""
},
{
 "PasswordGeneratorID": 112,
 "GeneratorName": "Default Password Generator2",
 "GeneratorDescription": "Default Password Generator with medium complexity of alphanumeric characters",
 "IncludeAlphaSpecial": true,
 "IncludeWordPhrases": true,
 "MinLength": 5,
 "MaxLength": 27
 "LowerCaseChars": true,
 "UpperCaseChars": true,
 "NumericChars": true,
 "HigherAlphaRatio": true,
 "AmbiguousChars": false,
 "SpecialChars": true,
 "BracketChars": false,
 "SpecialCharsText": "!@#$%^&*+/=_-",
 "BracketCharsText": "[](){}<>",
 "NumberOfWords": 1,
 "MaximumWordLength": 7,
 "PrefixAppendWords": "P",
 "SeparateWordsWith": "D",
 "ExcludeChars": "",
 "GeneratePattern": false,
 "Pattern": ""
}
]