PasswordPolicy interface
Stay organized with collections
Save and categorize content based on your preferences.
A structure specifying password policy requirements.
Signature:
export interface PasswordPolicy
Properties
| Property |
Type |
Description |
| allowedNonAlphanumericCharacters |
string |
List 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. |
| enforcementState |
string |
The enforcement state of the policy. Can be 'OFF' or 'ENFORCE'. |
| forceUpgradeOnSignin |
boolean |
Whether existing passwords must meet the policy. |
PasswordPolicy.allowedNonAlphanumericCharacters
List of characters that are considered non-alphanumeric during validation.
Signature:
readonly allowedNonAlphanumericCharacters: string;
PasswordPolicy.customStrengthOptions
Requirements enforced by this password policy.
Signature:
readonly customStrengthOptions: {
readonly minPasswordLength?: number;
readonly maxPasswordLength?: number;
readonly containsLowercaseLetter?: boolean;
readonly containsUppercaseLetter?: boolean;
readonly containsNumericCharacter?: boolean;
readonly containsNonAlphanumericCharacter?: boolean;
};
PasswordPolicy.enforcementState
The enforcement state of the policy. Can be 'OFF' or 'ENFORCE'.
Signature:
readonly enforcementState: string;
PasswordPolicy.forceUpgradeOnSignin
Whether existing passwords must meet the policy.
Signature:
readonly forceUpgradeOnSignin: boolean;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-08-17 UTC.
[null,null,["Last updated 2023-08-17 UTC."],[],[],null,["# PasswordPolicy interface\n\nA structure specifying password policy requirements.\n\n**Signature:** \n\n export interface PasswordPolicy \n\nProperties\n----------\n\n| Property | Type | Description |\n|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|\n| [allowedNonAlphanumericCharacters](./auth.passwordpolicy.md#passwordpolicyallowednonalphanumericcharacters) | string | List of characters that are considered non-alphanumeric during validation. |\n| [customStrengthOptions](./auth.passwordpolicy.md#passwordpolicycustomstrengthoptions) | { readonly minPasswordLength?: number; readonly maxPasswordLength?: number; readonly containsLowercaseLetter?: boolean; readonly containsUppercaseLetter?: boolean; readonly containsNumericCharacter?: boolean; readonly containsNonAlphanumericCharacter?: boolean; } | Requirements enforced by this password policy. |\n| [enforcementState](./auth.passwordpolicy.md#passwordpolicyenforcementstate) | string | The enforcement state of the policy. Can be 'OFF' or 'ENFORCE'. |\n| [forceUpgradeOnSignin](./auth.passwordpolicy.md#passwordpolicyforceupgradeonsignin) | boolean | Whether existing passwords must meet the policy. |\n\nPasswordPolicy.allowedNonAlphanumericCharacters\n-----------------------------------------------\n\nList of characters that are considered non-alphanumeric during validation.\n\n**Signature:** \n\n readonly allowedNonAlphanumericCharacters: string;\n\nPasswordPolicy.customStrengthOptions\n------------------------------------\n\nRequirements enforced by this password policy.\n\n**Signature:** \n\n readonly customStrengthOptions: {\n readonly minPasswordLength?: number;\n readonly maxPasswordLength?: number;\n readonly containsLowercaseLetter?: boolean;\n readonly containsUppercaseLetter?: boolean;\n readonly containsNumericCharacter?: boolean;\n readonly containsNonAlphanumericCharacter?: boolean;\n };\n\nPasswordPolicy.enforcementState\n-------------------------------\n\nThe enforcement state of the policy. Can be 'OFF' or 'ENFORCE'.\n\n**Signature:** \n\n readonly enforcementState: string;\n\nPasswordPolicy.forceUpgradeOnSignin\n-----------------------------------\n\nWhether existing passwords must meet the policy.\n\n**Signature:** \n\n readonly forceUpgradeOnSignin: boolean;"]]
