> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/rdm/knowledge-base/knowledge-base-articles/entry-settings/passwordstate.md).

# Passwordstate

Configure the Passwordstate entry in Remote Desktop Manager to authenticate with your Passwordstate server and retrieve passwords into sessions.

This article details the many settings and options available for Passwordstate entries in Remote Desktop Manager.

{% hint style="info" %}
The fields shown depend on the selected ***API mode*** and ***Passwordstate version***. ***Standard*** mode authenticates with an ***API key*** (version 9 or earlier) or a ***User ID*** and ***User API key*** (version 10 or later); ***Windows integrated (Active Directory)*** mode authenticates with a Windows ***Username***, ***Domain***, and ***Password*** instead.
{% endhint %}

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td><strong>SETTINGS</strong></td><td><strong>DESCRIPTION</strong></td></tr><tr><td><strong>Name</strong></td><td>The name of the entry.</td></tr><tr><td><strong>Folder</strong></td><td>The folder where the entry is located. A folder can be selected by clicking the arrow or the three dots to open the <strong>Folder</strong> window. To create a new folder, click on the plus (<strong>+</strong>) icon.</td></tr></tbody></table>

### General

<table><thead><tr><th width="220">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Service URL</strong></td><td>The base URL of your Passwordstate server. Click the globe icon to open the URL in your browser.</td></tr><tr><td><strong>Port</strong></td><td>The port used to connect to the Passwordstate server. Defaults to <code>9119</code>.</td></tr><tr><td><strong>Use "My account settings"</strong></td><td>Use the Passwordstate settings configured in <em><strong>File</strong></em> – <em><strong>My account settings</strong></em> – <em><strong>PasswordState</strong></em> instead of entering them below. When enabled, the authentication fields below are disabled. This option is hidden when a policy disables <em><strong>My account settings</strong></em>.</td></tr><tr><td><strong>API mode</strong></td><td><p>Choose how Remote Desktop Manager authenticates with the Passwordstate API. Disabled when <em><strong>Use "My account settings"</strong></em> is enabled.</p><ul><li><strong>Standard</strong> — Authenticate with an API key (version 9 or earlier) or a user ID and user API key (version 10 or later).</li><li><strong>Windows integrated (Active Directory)</strong> — Authenticate with Windows credentials instead of an API key.</li></ul></td></tr><tr><td><strong>Passwordstate version</strong></td><td><p>Select the Passwordstate server version, which determines the fields shown below. Disabled when <em><strong>Use "My account settings"</strong></em> is enabled.</p><ul><li><strong>Version 9 or earlier</strong> — Authenticate with an <em><strong>API key</strong></em>.</li><li><strong>Version 10 or later</strong> — Authenticate with a <em><strong>User ID</strong></em> and <em><strong>User API key</strong></em>.</li></ul></td></tr><tr><td><strong>User ID</strong></td><td>Shown when <em><strong>API mode</strong></em> is <em><strong>Standard</strong></em> and <em><strong>Passwordstate version</strong></em> is <em><strong>Version 10 or later</strong></em>. The user ID of the Passwordstate account used to authenticate with the API. You can find it at the top of the <em><strong>User Preferences</strong></em> page in Passwordstate.</td></tr><tr><td><strong>User API key</strong></td><td>Shown when <em><strong>API mode</strong></em> is <em><strong>Standard</strong></em> and <em><strong>Passwordstate version</strong></em> is <em><strong>Version 10 or later</strong></em>. The API key of the Passwordstate user account used to authenticate with the API. You can generate or copy it from the <em><strong>API</strong></em> tab on the <em><strong>User Preferences</strong></em> page in Passwordstate.<br><br>The <em><strong>User ID</strong></em> and <em><strong>User API key</strong></em> are required unless <em><strong>Use "My account settings"</strong></em> is enabled.</td></tr><tr><td><strong>API key</strong></td><td>Shown when <em><strong>API mode</strong></em> is <em><strong>Standard</strong></em> and <em><strong>Passwordstate version</strong></em> is <em><strong>Version 9 or earlier</strong></em>. The Passwordstate API key used to authenticate with the API. The API key is required unless <em><strong>Use "My account settings"</strong></em> is enabled. Once a <em><strong>Service URL</strong></em> is entered, click the help icon to open the API authentication documentation of your Passwordstate server.</td></tr><tr><td><strong>Send through header</strong></td><td>Shown alongside <em><strong>API key</strong></em>. When enabled, sends the API key through the request header instead of the URL.</td></tr><tr><td><strong>Use default credentials</strong></td><td>Shown when <em><strong>API mode</strong></em> is <em><strong>Windows integrated (Active Directory)</strong></em>. Use the credentials of the currently logged-in Windows user instead of entering a <em><strong>Username</strong></em>, <em><strong>Domain</strong></em>, and <em><strong>Password</strong></em> below. Disabled when <em><strong>Use "My account settings"</strong></em> is enabled.</td></tr><tr><td><strong>Username</strong></td><td>Shown when <em><strong>API mode</strong></em> is <em><strong>Windows integrated (Active Directory)</strong></em> and <em><strong>Use default credentials</strong></em> is disabled. The Windows username used to authenticate with the Passwordstate API. Required unless <em><strong>Use "My account settings"</strong></em> is enabled.</td></tr><tr><td><strong>Domain</strong></td><td>Shown when <em><strong>API mode</strong></em> is <em><strong>Windows integrated (Active Directory)</strong></em> and <em><strong>Use default credentials</strong></em> is disabled. The Windows domain of the account used to authenticate with the Passwordstate API.</td></tr><tr><td><strong>Password</strong></td><td>Shown when <em><strong>API mode</strong></em> is <em><strong>Windows integrated (Active Directory)</strong></em> and <em><strong>Use default credentials</strong></em> is disabled. The password of the Windows account used to authenticate with the Passwordstate API. Required unless <em><strong>Use "My account settings"</strong></em> is enabled.</td></tr><tr><td><strong>Password list</strong></td><td>The Passwordstate password list this entry retrieves its password from. Click <em><strong>Browse...</strong></em> to pick one, or <em><strong>Refresh</strong></em> to reload the current selection. This field is available once the <em><strong>Service URL</strong></em> and the authentication fields are filled, or <em><strong>Use "My account settings"</strong></em> is enabled, and only when <em><strong>Always prompt with list</strong></em> is disabled. <em><strong>Refresh</strong></em> is shown once a password list is selected.</td></tr><tr><td><strong>Selected password</strong></td><td>The specific password this entry retrieves from the selected <em><strong>Password list</strong></em>. Click <em><strong>Browse...</strong></em> to pick one, or <em><strong>Refresh</strong></em> to reload the current selection. This field is available once a <em><strong>Password list</strong></em> is selected.</td></tr><tr><td><strong>Always prompt with list</strong></td><td>When enabled, prompts you to choose a password from the <em><strong>Password list</strong></em> every time the entry is used, instead of always using the <em><strong>Selected password</strong></em>. This option is available once the <em><strong>Service URL</strong></em> and the authentication fields are filled, or <em><strong>Use "My account settings"</strong></em> is enabled.</td></tr><tr><td colspan="2"><strong>API one-time password</strong></td></tr><tr><td><strong>Secret key</strong></td><td>Used to generate the one-time password required when the API key is protected by a one-time password in Passwordstate. You can copy it in Passwordstate when configuring the API key.</td></tr></tbody></table>

### Advanced

<table><thead><tr><th width="220">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Get domain from generic fields</strong></td><td>When enabled, populates the <em><strong>Domain</strong></em> field from the generic fields set on the password in Passwordstate.</td></tr><tr><td><strong>Allow OTP retrieval</strong></td><td>When enabled, allows Remote Desktop Manager to retrieve a one-time password from Passwordstate for this entry.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.devolutions.net/rdm/knowledge-base/knowledge-base-articles/entry-settings/passwordstate.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.