Stytch · Schema

api_password_v1_Feedback

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name Type Description
warning string For `zxcvbn` validation, contains an end user consumable warning if the password is valid but not strong enough.
suggestions array For `zxcvbn` validation, contains end user consumable suggestions on how to improve the strength of the password.
luds_requirements object Contains which LUDS properties are fulfilled by the password and which are missing to convert an invalid password into a valid one. You'll use these fields to provide feedback to the user on how to im
View JSON Schema on GitHub

JSON Schema

stytch-api-password-v1-feedback-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_password_v1_Feedback",
  "title": "api_password_v1_Feedback",
  "type": "object",
  "properties": {
    "warning": {
      "type": "string",
      "description": "For `zxcvbn` validation, contains an end user consumable warning if the password is valid but not strong enough."
    },
    "suggestions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "For `zxcvbn` validation, contains end user consumable suggestions on how to improve the strength of the password."
    },
    "luds_requirements": {
      "$ref": "#/components/schemas/api_password_v1_LUDSRequirements",
      "description": "Contains which LUDS properties are fulfilled by the password and which are missing to convert an invalid password into a valid one. You'll use these fields to provide feedback to the user on how to improve the password."
    }
  },
  "required": [
    "warning",
    "suggestions"
  ]
}