Strength Check
Checks the strength of a password according to your Project’s password strength configuration.
Password feedback
Thezxcvbn_feedback and luds_feedback objects contains relevant information to relay to users that failed to create a strong enough password.
If using zxcvbn, the feedback object will contain warning and suggestions for any password that does not meet the zxcvbn strength requirements. You can return these strings directly to the user to help them craft a strong password.
If using LUDS, the feedback object will contain a collection of fields that the user failed or passed. You should prompt the user to create a password that meets all requirements that they failed.Authorizations
Body
Response
Successful response
Returns true if the password passes our password validation. We offer two validation options,
zxcvbn is the default option which offers a high level of sophistication.
We also offer LUDS which is less sophisticated
but easier to understand. If an email address is included in the call we also
require that the password hasn't been compromised using built-in breach detection powered by HaveIBeenPwned
The score of the password determined by zxcvbn. Values will be between 1 and 4, a 3 or greater is required to pass validation.
Returns true if the password has been breached. Powered by HaveIBeenPwned.
Will return true if breach detection will be evaluated. By default this option is enabled.
This option can be disabled in the dashboard.
If this value is false then breached_password will always be false as well.
Feedback for how to improve the password's strength using luds.
Feedback for how to improve the password's strength using zxcvbn.