Data model

The Password Rule object contains the following properties.

For definitions of the qualifier abbreviations in the following tables, see Property characteristics.

Table 1. Password Rule object: properties
Name	Qualifier	Type	Description
element-uri	—	String/ URI	The canonical URI path for a Password Rule object is of the form `/api/console/password-rules/{password-rule-id}`, where `{password-rule-id}` is the value of the element-id property of the Password Rule object.
element-id	—	String (36)	The unique identifier for this object.
parent	—	String/ URI	The canonical URI path of the console object.
class	—	String	The class of a Password Rule object is "password-rule".
name	(ro)	String	The name of the Password Rule object. This name must be unique among all password rules on the console. While preexisting Password Rule names are virtually unrestricted in terms of length and characters, new Password Rule names must conform to the length and character requirements of the name property described in the Base managed object properties schema. For the purpose of verifying uniqueness, this name is treated in a case-insensitive fashion when used to create a new Password Rule object.
description	(w)	String (0-1024)	The description of the Password Rule object. Default: an empty string
type	—	String Enum	Identifies the type of password rule. It must be one of the following values: "system-defined" - A password rule defined by the system. System-defined rules may not be modified. "user-defined" - A password rule defined by a user.
expiration	(w)	Integer	The total number of days a password is valid before it expires. A value of 0 indicates that the password never expires. Default: 0
min-length	(w)	Integer (1-256)	The minimum required length of the password. Cannot be greater than max-length. Default: 8
max-length	(w)	Integer (1-256)	The maximum allowed length of the password. Cannot be less than min-length. Default: 256
consecutive-characters	(w)	Integer	The maximum number of characters that are allowed to be repeated in a row. A value of 0 indicates that there is no such limit. Default: 0
similarity-count	(w)	Integer	The maximum number of consecutive characters in the current password that can match consecutive characters in the previous password. A value of 0 indicates that there is no such limit. Default: 0
history-count	(w)	Integer	The number of previous passwords to which a new password is compared for uniqueness. A value of 0 indicates that there is no such comparison. Default: 0
case-sensitive	(w)	Boolean	Indicates whether the password is case sensitive. Default: false
character-rules	(w)	Array of objects	Optional rules to be applied to individual parts of the password. These rules are applied, in order, to the password, from left to right. Each of these rules must be met by some part of the password in order for the password to meet the requirements of this Password Rule. This property is an array of nested character-rule objects as described in the next table. If there are no rule parts, an empty array is provided. Default: <empty array>
replication-overwrite-possible	—	Boolean	Indicates whether this object is customizable data that is replicated to this HMC from an HMC configured as a Data Source in the Data Replication service.

Each nested password-rule-part object contains the following fields:

Table 2. character-rule object properties
Name	Type	Description
min-characters	Integer	The minimum number of characters required by this password rule part. Must be at least 1, and cannot be greater than max-characters.
max-characters	Integer	The maximum number of characters allowed by this password rule part. Must be at least 1, and cannot be less than min-characters.
alphabetic	String Enum	This field determines the inclusion of alphabetic characters within this part of the password. It must be one of the following values: "allowed" - There can be alphabetic characters. "not-allowed" - There cannot be alphabetic characters. "required" - There must be alphabetic characters.
numeric	String Enum	This field determines the inclusion of numeric characters within this part of the password. It must be one of the following values: "allowed" - There can be numeric characters. "not-allowed" - There cannot be numeric characters. "required" - There must be numeric characters.
special	String Enum	This field determines the inclusion of special characters within this part of the password. It must be one of the following values: "allowed" - There can be special characters. "not-allowed" - There cannot be special characters. "required" - There must be special characters. Special characters include: greater than (>), less than (<), tilde (~), exclamation mark (!), at sign (@), number sign (#), question mark (?), dollar sign ($), vertical bar (\|), percent sign (%), caret (^), ampersand (&), asterisk (*), left and right parentheses ( ), underscore (_), plus sign (+), hyphen (-), equals sign (=), left and right curly braces ({ }), left and right square brackets ([ ]), back slash (\), forward slash (/), period (.), comma (,), colon (:), accent (`), quotation mark ("), semicolon (;), and apostrophe (').
custom-character-sets	Array of objects	Optional specific character requirements for this password part, as specified in an array of nested custom-character-set objects defined in the next table. This allows the specification of custom character sets and their inclusion requirement. There can be up to 2 custom character sets for a rule part. If none are defined, an empty array is provided.

Each nested specific-property object contains the following fields:

Table 3. custom-character-set object properties
Name	Type	Description
character-set	String	A string consisting of the characters that comprise this custom character set.
inclusion	String Enum	This field determines the inclusion of characters in this character set within part of the password. It must be one of the following values: "allowed" - Characters can be included. "not-allowed" - Characters cannot be included. "required" - At least one character must be included.