Password policies
Password policies are formerly known as password rules but the API remains PasswordRules to be compatible with earlier versions.
Quick navigation
GET PasswordRules
Purpose
Returns a list of password rules.
Required permissions
Password Safe System Management (Read).
Request body
None.
Response body
Content-Type: application/json
[ { PasswordRuleID : int, Name : string, Description : string, MinimumLength : int, MaximumLength : int, FirstCharacterRequirement : char, LowercaseRequirement : char, UppercaseRequirement : char, NumericRequirement : char, SymbolRequirement : char, ValidLowercaseCharacters : char[], ValidUppercaseCharacters : char[], ValidSymbols : char[], EnabledProducts : int }, … ]
Response body details
- FirstCharacterRequirement: The first character of the password must be:
- C: Characters (alpha) only.
- N: Numeric permitted, in addition to alpha characters.
- A: Any character permitted.
- LowercaseRequirement: Lowercase character requirements:
- UppercaseRequirement: Uppercase character requirements:
- NumericRequirement: Numeric requirements:
- SymbolRequirement: Symbol requirements:
- N: Not permitted.
- P: Permitted, not required.
- R: Required.
- EnabledProducts: The type of products to return:
- 1: Password Safe.
- 2: Secrets Safe.
Response codes
200 - Request successful. Password Rules in the response body.
400 - Enabled product not valid.
For more information, please see Common response codes.
GET PasswordRules?enabledproducts={productName}
Purpose
Returns a list of password rules, with an optional parameter to return polices enabled for Password Safe or Secrets Safe.
Required permissions
Password Safe System Management (Read).
Query parameters
{string} The product name to select polices enabled for Password Safe or Secrets Safe:
- 1: PasswordSafe
- 2: SecretsSafe
Request body
None.
Response body
Content-Type: application/json
[ { PasswordRuleID : int, Name : string, Description : string, MinimumLength : int, MaximumLength : int, FirstCharacterRequirement : char, LowercaseRequirement : char, UppercaseRequirement : char, NumericRequirement : char, SymbolRequirement : char, ValidLowercaseCharacters : char[], ValidUppercaseCharacters : char[], ValidSymbols : char[], EnabledProducts : int }, … ]
Response body details
- FirstCharacterRequirement: The first character of the password must be:
- C: Characters (alpha) only.
- N: Numeric permitted, in addition to alpha characters.
- A: Any character permitted.
- LowercaseRequirement: Lowercase character requirements:
- UppercaseRequirement: Uppercase character requirements:
- NumericRequirement: Numeric requirements:
- SymbolRequirement: Symbol requirements:
- N: Not permitted.
- P: Permitted, not required.
- R: Required.
- EnabledProducts: The type of products to return:
- 1: Password Safe.
- 2: Secrets Safe.
Response codes
200 - Request successful. Password Rules in the response body.
400 - Enabled product not valid.
For more information, please see Common response codes.
GET PasswordRules/{id}
Purpose
Returns a password rule by ID.
Required permissions
Password Safe System Management (Read).
URL parameters
id: ID of the password rule.
Request body
None.
Response body
Content-Type: application/json
{ PasswordRuleID: int, Name: string, Description: string, MinimumLength: int, MaximumLength: int, FirstCharacterRequirement: char, LowercaseRequirement: char, UppercaseRequirement: char, NumericRequirement: char, SymbolRequirement: char, ValidLowercaseCharacters: char[], ValidUppercaseCharacters: char[], ValidSymbols: char[], EnabledProducts : int }
Response body details
- FirstCharacterRequirement: The first character of the password must be:
- C: Characters (alpha) only.
- N: Numeric permitted, in addition to alpha characters.
- A: Any character permitted.
- LowercaseRequirement: Lowercase character requirements:
- UppercaseRequirement: Uppercase character requirements:
- NumericRequirement: Numeric requirements:
- SymbolRequirement: Symbol requirements:
- N: Not permitted.
- P: Permitted, not required.
- R: Required.
- EnabledProducts: The type of products to return:
- 1: Password Safe.
- 2: Secrets Safe.
Response codes
200 - Request successful. Password rules in the response body.
400 - Enabled product not valid.
For more information, please see Common response codes.