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

Returns a list of password rules.

Password Safe System Management (Read).

None.

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[],
    },
    …
]
  • 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.

200 - Request successful. Password Rules in the response body.

For more information, please see Common Response Codes.

GET PasswordRules/{id}

Returns a password rule by ID.

Password Safe System Management (Read).

id: ID of the password rule.

None.

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[],
}
  • 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.

200 - Request successful. Password rules in the response body.

For more information, please see Common Response Codes.