> 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/beyondtrust-password-safe.md).

# BeyondTrust Password Safe

Configure BeyondTrust Password Safe session entries in Remote Desktop Manager, including the portal host, API key, system, session type, and connect mode.

This article details the many settings and options available for ***BeyondTrust Password Safe*** session entries in Remote Desktop Manager.

{% hint style="info" %}
Without a valid license, a ***License key is required*** banner appears above the settings and the settings cannot be edited. For a step-by-step setup of every BeyondTrust entry type, see [BeyondTrust configuration](https://docs.devolutions.net/rdm/integrations/pam/beyondtrust.md).
{% 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. Click the browse button to select a folder, or click the add (<em><strong>+</strong></em>) button to create a new one.</td></tr><tr><td><strong>Display</strong></td><td>How the entry opens. This entry type only supports <em><strong>External</strong></em>, so the display mode cannot be changed. Additional lists let you choose the monitor and the virtual desktop where the window opens.</td></tr><tr><td><strong>Host</strong></td><td>Where the host of the entry comes from. <em><strong>Host configured</strong></em> uses the <em><strong>Host</strong></em> entered in the <em><strong>General</strong></em> tab. <em><strong>Linked</strong></em> uses a host entry from the vault selected in the <em><strong>Vault</strong></em> list. <em><strong>Inherited</strong></em> uses the host of a parent folder.</td></tr><tr><td><strong>Credentials</strong></td><td>How the credentials of the entry are provided. Select a credential mode from the list. When the credentials do not come from the entry itself, the <em><strong>Username</strong></em>, <em><strong>Domain</strong></em>, and <em><strong>Password</strong></em> of the <em><strong>General</strong></em> tab are disabled.</td></tr></tbody></table>

### General

<table><thead><tr><th width="220">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Host</strong></td><td>The URL of the BeyondTrust Password Safe server. Enter only the host and the port, starting with <code>http://</code> or <code>https://</code> (for example <code>https://your-server:8080</code>). Required when the host is configured in the entry. Disabled when the host comes from a linked or inherited host.</td></tr><tr><td><strong>Username</strong></td><td>The username of the account that connects to BeyondTrust Password Safe. Required unless the credentials come from another source.</td></tr><tr><td><strong>Domain</strong></td><td>The domain of the account that connects to BeyondTrust Password Safe.</td></tr><tr><td><strong>Password</strong></td><td>The password of the account that connects to BeyondTrust Password Safe. Disabled when the <em><strong>Disable password saving in vaults</strong></em> setting is enabled.</td></tr><tr><td><strong>Application API key</strong></td><td>The key of a BeyondTrust API registration used to authenticate to the server. The BeyondInsight version must be 6.0.2 or higher.</td></tr></tbody></table>

### Advanced

<table><thead><tr><th width="220">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>System</strong></td><td>The managed system to connect to. Click the browse button to sign in to BeyondTrust Password Safe with the information of the <em><strong>General</strong></em> tab and select an account from the list. Selecting an account fills <em><strong>System</strong></em> and <em><strong>Account</strong></em>. Required.</td></tr><tr><td><strong>Account</strong></td><td>The managed account of the selected system. Filled automatically when an account is selected with the <em><strong>System</strong></em> browse button. Read-only. Required.</td></tr><tr><td><strong>Template</strong></td><td>The template applied to the session. Click the browse button to select a shared template.</td></tr><tr><td><strong>Session type</strong></td><td><p>The type of session to open. Selecting an account sets this value from the default access type of the account. Select one of:</p><ul><li><strong>RDP</strong></li><li><strong>SSH</strong></li></ul></td></tr><tr><td><strong>Host field</strong></td><td><p>The value of the managed system used as the host of the session. Select one of:</p><ul><li><strong>System name</strong></li><li><strong>IP address</strong></li><li><strong>DNS name</strong></li></ul></td></tr><tr><td><strong>Connect mode</strong></td><td><p>How the session connects. Select one of:</p><ul><li><strong>Proxy</strong></li><li><strong>Direct</strong></li><li><strong>Admin session</strong></li></ul></td></tr><tr><td><strong>Check-in request on close</strong></td><td>Shown when <em><strong>Connect mode</strong></em> is <em><strong>Proxy</strong></em> or <em><strong>Direct</strong></em>. Checks in the credential request when the session closes.</td></tr><tr><td><strong>Credential mode</strong></td><td><p>Shown when <em><strong>Connect mode</strong></em> is <em><strong>Admin session</strong></em>. Where the administrator credentials come from. Select one of:</p><ul><li><strong>Custom</strong> — Enter the <em><strong>Username</strong></em>, <em><strong>Domain</strong></em>, and <em><strong>Password</strong></em> of the administrator account in the fields below the list.</li><li><strong>Linked</strong> — Use a <em><strong>BeyondTrust Admin session</strong></em> entry. Select the vault that holds the entry in the <em><strong>Vault</strong></em> list, then select the entry in the list below, which is required. Selecting the user vault from an entry in a shared vault shows a text box to enter the name of the entry to search for.</li></ul></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/beyondtrust-password-safe.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.
