--- title: Attribute Value Password Validator description: The Attribute Value Password Validator attempts to determine whether a proposed password is acceptable for use by checking whether the password matches or contains attribute values from the user's entry. component: pingds version: 8.1 page_id: pingds:configref:objects-attribute-value-password-validator canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-attribute-value-password-validator.html section_ids: parent: Parent attribute_value_password_validator_properties: Attribute Value Password Validator properties basic_properties: Basic properties check-substrings: check-substrings enabled: enabled match-attribute: match-attribute min-substring-length: min-substring-length test-reversed-password: test-reversed-password advanced_properties: Advanced properties java-class: java-class --- # Attribute Value Password Validator The Attribute Value Password Validator attempts to determine whether a proposed password is acceptable for use by checking whether the password matches or contains attribute values from the user's entry. It can be configured to look in all attributes or in a specified subset of attributes. ## Parent The Attribute Value Password Validator object inherits from [Password Validator](objects-password-validator.html). ## Attribute Value Password Validator properties You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html). | Basic Properties | Advanced Properties | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | [check-substrings](#check-substrings) [enabled](#enabled) [match-attribute](#match-attribute) [min-substring-length](#min-substring-length) [test-reversed-password](#test-reversed-password) | [java-class](#java-class) | ### Basic properties Use the `--advanced` option to access advanced properties. ### check-substrings | | | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Indicates whether this password validator is to match portions of the password string against attribute values and portions of attribute values against the password string. | | *Description* | If "false" then only match the entire password against attribute values; otherwise ("true"), check whether the password contains portions of attribute values and whether the attribute values contain portions of the password. | | *Default value* | true | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### enabled | | | | ----------------------- | ------------------------------------------------------------ | | *Synopsis* | Indicates whether the password validator is enabled for use. | | *Default value* | None | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### match-attribute | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | *Synopsis* | Specifies the name(s) of the attribute(s) whose values should be checked to determine whether they match the provided password. If no values are provided, then the server checks if the proposed password matches the value of any attribute in the user's entry. | | *Default value* | All attributes in the user entry will be checked. | | *Allowed values* | The name of an attribute type defined in the LDAP schema. | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### min-substring-length | | | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Indicates the minimal length (inclusive) of the substring within the password in case substring checking is enabled. | | *Description* | If "check-substrings" option is set to true, then this parameter defines the length (inclusive) of the smallest word which should be used for substring matching. | | *Default value* | 5 | | *Allowed values* | An integer.Lower limit: 3. | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### test-reversed-password | | | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Indicates whether this password validator should test the reversed value of the provided password as well as the order in which it was given. | | *Default value* | None | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ## Advanced properties Use the `--advanced` option to access advanced properties. ### java-class | | | | ----------------------- | --------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the fully-qualified name of the Java class that provides the password validator implementation. | | *Default value* | org.opends.server.extensions.AttributeValuePasswordValidator | | *Allowed values* | A Java class that extends or implements:- org.opends.server.api.PasswordValidator | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | The object must be disabled and re-enabled for changes to take effect. | | *Advanced* | Yes | | *Read-only* | No |