> 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/ribbon-menu-bar/edit/checkout-system.md).

# Checkout system

Configure the checkout system in Remote Desktop Manager to lock entries, set checkout modes, prompts, and allow multiple checkouts.

Devolutions' check out system is used to lock an entry while it is being used or modified. It prevents users from using or editing the same entry simultaneously. A check out mode can be set at the vault, folder or entry level.

Here are the entry types that can benefit from the check out system:

* ***Sessions***
* ***Documents***
* ***Credentials***
* ***Information***

Administrators can also force users to check in their entries at any time by right-clicking on a checked out entry. If the entry is checked out by the current user, ***Check in*** checks in that user's own checkout only. If the entry is checked out only by other users and the current user holds the ***Check in (force)*** permission, the action becomes ***Check in other users*** instead. What's more, they can automate check-ins after a determined amount of minutes in ***Administration*** – ***System settings*** – ***Vault***.

### Check out or check in a folder, a multi-selection, or sub-entries

Checking out a folder, a multi-selection, or an entry with sub-entries opens a selection window listing every entry that will be affected, with everything selected by default. Entries where the check out system is disabled, as well as PAM entries, are not shown. Sub-entries are handled the same way as a folder: the parent entry is treated as the "folder" and its sub-entries as the "entries".

* ***Checkout folder only*** (or ***Checkout parent only*** for sub-entries): checks out the folder or parent entry, not its contents.
* ***Checkout contents of folder only*** (or ***Checkout contents of parent only***): checks out the contents without the folder or parent entry.
* Clear or select individual entries in the list to check out a custom selection.

Checking in a folder, a multi-selection, or a parent entry's sub-entries only lists the entries currently checked out by the current user.

Once the operation completes, a notification reports how many entries were successfully checked out or checked in. If some entries fail while others succeed, a window lists which entries failed and why, along with the number that succeeded. If every entry fails, a notification explains why.

{% hint style="info" %}
A multi-selection that spans more than one vault — for example, in the ***Favorites*** tab — cannot be checked out or checked in together. The check out and check in actions are hidden for that selection.
{% endhint %}

### Force check-in

Forcing the check-in of a single entry that is checked out by multiple users opens a selection window to choose which of those checkouts to check in. Forcing the check-in of a multi-selection or a folder's contents checks in every checkout on every selected entry, after a warning that this also releases checkouts held by other users.

### Checkout of linked entries

Checking out an entry also checks out its linked credential and linked one-time password (OTP) entry, if any, under a single prompt. Checking in the entry automatically checks in those linked entries as well, once nothing else requires them to stay checked out.

### Checkout status

The entry's [Overview dashboard tab](/rdm/user-interface/content-area/dashboard/dashboard-tabs/overview.md) displays a ***Checkout status*** section showing whether the entry is available, checked out by the current user, or checked out by others. From there, a checked-out-by-me entry can be checked in directly; forcing the check-in of another user's checkout is not available from this section.

{% hint style="info" %}
Copying information that is already visible without checking out the entry, such as the host, username, or domain, does not require a checkout. Copying or viewing sensitive information, such as the password, still requires it.
{% endhint %}

{% tabs %}
{% tab title="Windows" %}

#### Checkout mode

To access the check out settings, go into the ***Properties*** of an entry, folder, root folder or ***Vault settings***. Navigate to the ***Security settings*** section. There, administrators can decide how check outs are to function, or enable/disable the check out system altogether.

<table><thead><tr><th width="177.79998779296875">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Root (Default)</strong></td><td>Uses the <em><strong>Checkout mode</strong></em> setting from the root <em><strong>vault</strong></em> <em><strong>settings</strong></em>.</td></tr><tr><td><strong>Not available</strong></td><td>Disables the check out system.</td></tr><tr><td><strong>Automatic</strong></td><td>Checks out an entry automatically when the entry is opened and automatically checks the entry in when the entry is closed. Users can edit properties without checking out the entry.</td></tr><tr><td><strong>Manual</strong></td><td>Users need to check out the entry manually prior to opening or editing the entry. No action can be performed without checking out the entry.</td></tr><tr><td><strong>Inherited</strong></td><td>Inherits the check out mode from the parent folder.</td></tr><tr><td><strong>Optional</strong></td><td>Offers the option to check out an entry manually or use (open and edit) the entry without checking it out.</td></tr><tr><td><strong>Automatic (when supported)</strong></td><td>If online, automatically checks out an entry when it is opened, and automatically checks it in upon closing. Skips the check out process if offline.</td></tr></tbody></table>

When ***Automatic (when supported)*** is selected, an info icon next to the dropdown recalls this behavior.

#### Checkout prompt

***Checkout prompt*** sets if a user must enter a comment when they check out the entry. Administrators can monitor the comments through the logs available on the entry or the ***Activity logs***.

<table><thead><tr><th width="207.4000244140625">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Default</strong></td><td>Uses the <em><strong>Checkout prompt</strong></em> setting from the root folder.</td></tr><tr><td><strong>Yes</strong></td><td>Prompts the user for comment when they check out an entry.</td></tr><tr><td><strong>No</strong></td><td>Removes the prompt for comment.</td></tr><tr><td><strong>Inherited</strong></td><td>Inherits the setting from a parent folder.</td></tr><tr><td><strong>Yes (comment forced)</strong></td><td>Always prompt the user for comment when they check out an entry.</td></tr></tbody></table>

#### Multiple checkouts

**Multiple checkouts** allows more than one user to checkout the same entry at once.

<table><thead><tr><th width="138.60003662109375">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Default (Off)</strong></td><td>Uses the <em><strong>Multiple checkout</strong></em> setting from the <em><strong>Vault settings</strong></em> root.</td></tr><tr><td><strong>Off</strong></td><td>Only one user can check out an entry at a time.</td></tr><tr><td><strong>Infinite</strong></td><td>Users can check out and edit the same entry at once without restriction.</td></tr><tr><td><strong>Custom</strong></td><td>Lets you define the maximum number of users who can check out an entry at the same time.</td></tr></tbody></table>
{% endtab %}

{% tab title="macOS" %}

#### Checkout mode <a href="#checkout-mode-1" id="checkout-mode-1"></a>

To access the check out settings, go into the ***Properties*** of an entry, folder or of the root folder. Navigate to the ***Security settings*** section. There, administrators can decide how check outs are to function, or enable/disable the check out system altogether.

<table><thead><tr><th width="170.59991455078125">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Default (Optional)</strong></td><td>Offers the option to check out an entry manually or use (open and edit) the entry without checking it out.</td></tr><tr><td><strong>Not available</strong></td><td>Disables the check out system.</td></tr><tr><td><strong>Automatic</strong></td><td>Checks out an entry automatically when the entry is opened and automatically checks the entry in when the entry is closed. Users can edit properties without checking out the entry.</td></tr><tr><td><strong>Manual</strong></td><td>Users need to check out the entry manually prior to opening or editing the entry. No action can be performed without checking out the entry.</td></tr><tr><td><strong>Inherited</strong></td><td>Inherits the check out mode from the parent folder.</td></tr><tr><td><strong>Optional</strong></td><td>Offers the option to check out an entry manually or use (open and edit) the entry without checking it out.</td></tr><tr><td><strong>Automatic (when supported)</strong></td><td>If online, automatically checks out an entry when it is opened, and automatically checks it in upon closing. Skips the check out process if offline.</td></tr></tbody></table>

#### Checkout prompt <a href="#checkout-prompt-1" id="checkout-prompt-1"></a>

***Checkout prompt*** sets if a user must enter a comment when they check out the entry. Administrators can monitor the comments through the logs available on the entry or the ***Activity logs***.

<table><thead><tr><th width="131.39996337890625">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Root</strong></td><td>Uses the check out prompt setting from the root folder.</td></tr><tr><td><strong>Yes</strong></td><td>Prompts the user for comment when they check out an entry.</td></tr><tr><td><strong>No</strong></td><td>Removes the prompt for comment.</td></tr><tr><td><strong>Inherited</strong></td><td>Inherits the setting from a parent folder.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

#### See also

* [Devolutions Academy – Use the Checkout System in Remote Desktop Manager](https://academy.devolutions.net/student/page/3487229-use-the-checkout-system-in-remote-desktop-manager?curriculum_activity_id=5561271\&path_id=2628397\&sid=2edf4de7-10af-4217-b566-7033e8dd0d44\&sid_i=0)


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.devolutions.net/rdm/ribbon-menu-bar/edit/checkout-system.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.