PasswordPolicy interface

A structure specifying password policy requirements.

Signature:

exportinterfacePasswordPolicy

Properties

PropertyTypeDescription
allowedNonAlphanumericCharactersstringList of characters that are considered non-alphanumeric during validation.
customStrengthOptions{ readonly minPasswordLength?: number; readonly maxPasswordLength?: number; readonly containsLowercaseLetter?: boolean; readonly containsUppercaseLetter?: boolean; readonly containsNumericCharacter?: boolean; readonly containsNonAlphanumericCharacter?: boolean; }Requirements enforced by this password policy.
enforcementStatestringThe enforcement state of the policy. Can be 'OFF' or 'ENFORCE'.
forceUpgradeOnSigninbooleanWhether existing passwords must meet the policy.

PasswordPolicy.allowedNonAlphanumericCharacters

List of characters that are considered non-alphanumeric during validation.

Signature:

readonlyallowedNonAlphanumericCharacters:string;

PasswordPolicy.customStrengthOptions

Requirements enforced by this password policy.

Signature:

readonlycustomStrengthOptions:{readonlyminPasswordLength?:number;readonlymaxPasswordLength?:number;readonlycontainsLowercaseLetter?:boolean;readonlycontainsUppercaseLetter?:boolean;readonlycontainsNumericCharacter?:boolean;readonlycontainsNonAlphanumericCharacter?:boolean;};

PasswordPolicy.enforcementState

The enforcement state of the policy. Can be 'OFF' or 'ENFORCE'.

Signature:

readonlyenforcementState:string;

PasswordPolicy.forceUpgradeOnSignin

Whether existing passwords must meet the policy.

Signature:

readonlyforceUpgradeOnSignin:boolean;