Custom Fields

Custom fields, available for any vault item type, allow you to store additional well-structured data fields for a vault item. Custom fields are saved as Name:Value pairs, and can be one of four types:

• Text: Field value stores a freeform input (text, numbers, and more).

• Hidden: Field value stores freeform input that is hidden from view (particularly useful for organizations using the Hide Password access control).

• Boolean: Field value stores a boolean value (true/false).

• Linked: Field value is linked to the item's username or password. Given the right field name, linked custom fields can be used to solve issues where your browser extension can't auto-fill usernames and passwords for a particular site (learn more).

Custom fields can be added to a vault item from any Bitwarden client using the Custom Fields section of the Edit Item panel:

The specified Name is important to get right in order to successfully auto-fill a custom field. Using the Bitwarden browser extension, you can quickly get the correct field name using the Copy Custom Field Name option in the context menu (in most cases, by right-clicking on the form element):

Selecting this context menu option will copy the form element's id, name, aria-label, or placeholder value (in that order of preference).

Once you have saved a custom field, you can auto-fill it from the browser extension.

Find custom field names manually

If you don't use the browser extension, the best way to find a field name is to use your web browser's developer tools, as in the following example:

1. On the webpage that matches the login item's URI, right-click the field you want to auto-fill to and select Inspect. The HTML element will open and be highlighted in the developer console.

2. Find and copy the element id (find id="xxx", where xxx is the element's id value).

3. In the relevant vault item's Custom Fields section, choose the appropriate field type and select the  New Custom Field button:

   

4. Paste the copied element id in the Name field.

5. Specify the desired information to be auto-filled (in the above example, a PIN) in the Value field.

   

6. Save the vault item.

Once you have saved a custom field, you can auto-fill it from the browser extension.

Order of preference

If you are naming a custom field manually, you should use one of the following HTML form element attributes/values in order of preference:

1. HTML form element's id attribute.

2. HTML form element's name attribute.

3. HTML form element's aria-label attribute.

4. HTML form element's placeholder attribute.

Matching

Field name matching is an exact and case-insensitive comparison. For example, if your custom field has the name PIN:

• Auto-fill is offered for pin, PiN, PIN, etc.

• Auto-fill is not offered for pin2 or mypin

Prefixing

There are two cases in which you can exercise more control over matching by using prefixes:

• csv: Prefixing your custom field's name with csv= allows you to specify multiple names to search for and compare against for auto-fill, for example csv=pin,mypin,pincode.

• regex: Prefixing your custom field's name with regex= allows you to perform regular expression comparisons when auto-fill is performed. For example, regex=^first.*name will offer auto-fill for firstName, First_name, and First Name.