---
title: "system.gui.passwordBox"
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.gui.passwordBox

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

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.

## Client Permission Restrictions
This scripting function has no [Client Permission](projects\project-properties\project-properties.md#client---permissions) restrictions.

## Syntax
`system.gui.passwordBox(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
Client

## Code Examples
```python title="Example #1"
# This example would prompt a user for a password before opening the 'Admin' Screen.
  
password = system.gui.passwordBox("Please enter the password.")
if password == "open sesame":
   system.nav.openWindow("Admin")
```