Skip to main content

Password


Password fields collect secure user input. These fields support masked entry, validation, optional visibility toggles, and display error messages based on strength or policy rules.

Password input field with label and eye icon

Properties

PropertyValueDescription
TypePasswordUI component type
GroupFieldBelongs to the "Field" group in UI catalog
Identifier35Unique element ID
PreviewSee image preview above
ValueYAccepts user input
MandatoryYRequires input before form submission
ErrorYSupports validation error states
Read-onlyYCan be locked to prevent editing
Text, IconYDisplays label and visibility toggle icon
EventYTriggers validation or form logic
ShadeYUses shaded background style
ChildrenNo nested children
ListNot a list container
MinNo explicit minimum field value
MaxNo explicit maximum constraint

Usage Example

<Input type="password" label="New password" icon="eye" required />

SDK Integration

The Change Password screen uses this element. It links to the SDK method:

Method: /account/change-password

Requires current and new passwords. Validates strength and applies complexity rules.


Example UI Placement

LevelIDTypeValueDescription
1current-passwordPasswordCurrent passwordField for verifying existing password
1new-passwordPasswordNew passwordField for entering updated credentials

Notes

  • Displays visibility toggle icon to show or hide password.
  • Shows error if input does not meet policy requirements.
  • Typically appears in login, registration, and credential update flows.