PasswordPolicyConfig interface
Stay organized with collections
Save and categorize content based on your preferences.
A password policy configuration for a project or tenant
Signature:
export interface PasswordPolicyConfig
Properties
PasswordPolicyConfig.constraints
The constraints that make up the password strength policy
Signature:
constraints?: CustomStrengthOptionsConfig;
PasswordPolicyConfig.enforcementState
Enforcement state of the password policy
Signature:
enforcementState?: PasswordPolicyEnforcementState;
PasswordPolicyConfig.forceUpgradeOnSignin
Require users to have a policy-compliant password to sign in
Signature:
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-06-01 UTC.
[null,null,["Last updated 2023-06-01 UTC."],[],[],null,["# PasswordPolicyConfig interface\n\nA password policy configuration for a project or tenant\n\n**Signature:** \n\n export interface PasswordPolicyConfig \n\nProperties\n----------\n\n| Property | Type | Description |\n|----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|\n| [constraints](./firebase-admin.auth.passwordpolicyconfig.md#passwordpolicyconfigconstraints) | [CustomStrengthOptionsConfig](./firebase-admin.auth.customstrengthoptionsconfig.md#customstrengthoptionsconfig_interface) | The constraints that make up the password strength policy |\n| [enforcementState](./firebase-admin.auth.passwordpolicyconfig.md#passwordpolicyconfigenforcementstate) | [PasswordPolicyEnforcementState](./firebase-admin.auth.md#passwordpolicyenforcementstate) | Enforcement state of the password policy |\n| [forceUpgradeOnSignin](./firebase-admin.auth.passwordpolicyconfig.md#passwordpolicyconfigforceupgradeonsignin) | boolean | Require users to have a policy-compliant password to sign in |\n\nPasswordPolicyConfig.constraints\n--------------------------------\n\nThe constraints that make up the password strength policy\n\n**Signature:** \n\n constraints?: CustomStrengthOptionsConfig;\n\nPasswordPolicyConfig.enforcementState\n-------------------------------------\n\nEnforcement state of the password policy\n\n**Signature:** \n\n enforcementState?: PasswordPolicyEnforcementState;\n\nPasswordPolicyConfig.forceUpgradeOnSignin\n-----------------------------------------\n\nRequire users to have a policy-compliant password to sign in\n\n**Signature:** \n\n forceUpgradeOnSignin?: boolean;"]]