---
title: "system.vision.showPasswordInput"
description: "Pops up a special input box that uses a password field, so the text isn't echoed back in clear-text to the user."
---

# system.vision.showPasswordInput

> Pops up a special input box that uses a password field, so the text isn't echoed back in clear-text to the user.

:::info Backwards Compatibility
This function replaces [system.gui.passwordBox](versioned_docs/version-8.1/appendix/scripting-functions/system-gui/system-gui-passwordBox.md). Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility.
:::

This function is used in **Python Scripting**.

## Description
Pops up a special input box that uses a password field, so the text isn't echoed back in clear-text to the user. Returns the text they entered, or None if they canceled the dialog box.

:::note
This function is available on secondary desktops via the [system.vision.desktop](system-vision-desktop.md) function. See the [Multi-Monitor Clients](ignition-modules\vision\common-tasks-in-vision\multi-monitor-clients\multi-monitor-clients.md) page for more details on secondary desktops.
:::

## Client Permission Restrictions
This scripting function has no [Client Permission](../../../ignition-modules/vision/vision-project-properties/vision-project-properties.md#vision-permissions-properties) restrictions.

## Syntax
`system.vision.showPasswordInput(message, [title], [echoChar])`

### Parameters
Type | Parameter | Description 
------- | ------- | ------
String| `message` | The message for the password prompt. Will accept HTML formatting.
String| `title` | A title for the password prompt. [optional]
String| `echoChar` | A custom echo character. Defaults to: `*` [optional]

### Returns
**String** - The password that was entered, or None if the prompt was canceled.

### Scope
Vision Client

## Code Examples
```python title="Example #1"
# This example prompts a user for a password before opening the 'Admin' screen.
  
password = system.vision.showPasswordInput("Please enter the password.")
if password == "open sesame":
   system.vision.openWindow("Admin")
```