PasswordPolicy Object

Contains information about the password policy in effect for the business.

This object is used by the following operations:

The properties included in the PasswordPolicy object are listed below.

Property Type Description
MinPasswordLength integer The minimum number of characters allowed in a password.
MaxPasswordLength integer The maximum number of characters allowed in a password.
MinLetterCount integer The minimum number of letters required in a password.
MinNumberCount integer The minimum number of digits required in a password.
MinUpperLetterCount integer The minimum number of uppercase letters required in a password.
MinSpecialCharCount integer The minimum number of special characters required in a password.
AllowedSpecialCharacters AllowedSpecialCharacters

Contains information about the special characters that are allowed in the context (such as, in the answer to a security challenge question). If no special characters are specified, all characters are allowed.

If a value is provided for MinSpecialCharCount, at least one allowed special character must be defined.

CanContainSpaces boolean Indicates whether a password can include spaces.
IsCaseSensitive boolean Indicates whether a password is case sensitive.
CanMatchUserName boolean Indicates whether the password and the username can be the same.
NumbersOfLastPasswordCheckCount integer Indicates the number of previous passwords that the new password is checked against, and rejected if there is a match.
PasswordChangeIntervalDays integer Indicates the time interval, in days, before a user is prompted to change the password. If set to 0 (zero), password changing is not enforced.
CanMatchEmail boolean Indicates whether the password and the email address can be the same.