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: Team Passwords.
    • 3: Password Safe and Team Passwords.

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, Team Password, or both.

Required Permissions

Password Safe System Management (Read).

Query Parameters

{string} The product name to select polices enabled for Password Safe or Team Password:

  • 1: PasswordSafe
  • 2: TeamPasswords

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: Team Passwords.
    • 3: Password Safe and Team Passwords.

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: Team Passwords.
    • 3: Password Safe and Team Passwords.

Response Codes

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

400 - Enabled product not valid.

For more information, please see Common Response Codes.