Skip to main content

Password

The password widget provides a secure input field for sensitive information such as passwords or client secrets in your Atlan app. It masks user input to protect confidential data, supports placeholder text, validation rules, help text, and feedback messages. Use the password widget whenever you need users to enter secret values that shouldn't be displayed in plain text.

Password widget screenshot

How it works​

The password widget:

  • Masks user input to protect confidential data
  • Supports placeholder text and help messages
  • Provides validation feedback for user input
  • Integrates with form validation rules
  • Supports responsive grid layout

Props​

The password widget supports placeholder, help, feedback, grid, label, id, required, and rules. For more information, see Widget properties.

How to use​

The password widget is configured using standard widget properties. In the example below, the widget captures a password with validation rules and responsive grid layout:

{
  "password": {
    "type": "string",
    "required": true,
    "ui": {
      "widget": "password",
      "label": "Password",
      "feedback": true,
      "placeholder": "Password",
      "grid": 4,
      "rules": [
        {
          "required": true,
          "message": "Please enter a valid password"
        }
      ]
    }
  }
}
  • Input - Use for non-sensitive text input
  • Credential - Use for secure credential storage with vault integration

See also​

  • Widget properties - provides detailed information about common properties shared across all widgets.

Need help​

If you face any issues or need help with password widget configuration, contact Atlan support by submitting a support request.