Credential

Credentials are used to store username and password in a secure manner. By using and assigning credentials to connections, you can easily share your connections document while having all your credentials stored in a separate, private document.

Usage of Credentials

  • Assign credentials to connections by name instead of configuring connections to use username and password. This allows easy and secure file sharing in teams as no credentials are stored with the connections.
  • Simply store username and password in credential objects to quickly and easily access them using the Navigation or Credentials panel.
  • Use credentials in our Web Browser Extensions to automatically log on to web sites.
Tip

You can create credentials in any documents, including the Application document. It's strongly recommended to encrypt and password protect your document as soon as you create a credential with a password in it.

See also: Work with Credentials, Security

Credential Properties

The Credential Properties dialog is shown:

  • for a new credential by clicking the Credential menu item in the Add drop down menu in the Edit group on the Home ribbon tab.
  • for an existing credential by selecting a credential and clicking on the Properties command in the Edit group on the Home ribbon tab.
  • as a bulk-edit dialog when multiple credentials were selected in the Folder / Document Dashboard and the Properties command in the Edit group on the Home ribbon tab is clicked.

See also: Bulk Operations

Tip

Assigning credentials to connections using the name is recommended when a team of users share the same configuration file. Each user can define a credential with the same name in his own personal and protected document.

This makes sharing files across team members very easy while keeping credentials safe.

See Working with Personal Credentials in a Shared Document for more information.

Display Name (required)

Enter a display name for object.

Color

Click the color picker button in the display name text box to select a color. In the User Interface settings you can configure to show the color in the navigation tree, the connection tab or as connection border.

Icon

Click the icon picker button next in the display name text box to select and assign a custom icon to the object.

Username

Enter the username for the credential. For domain accounts use the "domain\username" syntax.

Password

Enter the password for the credential.

Description

Enter a description for the object.

Private Key File

The Private Key File tab page allows you to configure a path to a private key file and a passphrase. These settings are optional and only used by connection types supporting these settings (Terminal connections using SSH protocol, for example).

Private Key File

The path to the private key file.

Passphrase

The passphrase used for the private key file.

MFA

In case your connection requires a multi-factor-authentication (MFA) code included in your username or password, you can configure where the MFA code should be added here. A MFA code prompt will appear before the connection is established.

MFA Mode

  • Disabled: no MFA code is required.
  • Prompt: an MFA code is required. Royal TS will prompt for the code upon connect.

Property

Select whicht property should be used to add the MFA code (Effective Username or Effective Password).

Template

Use the {Value} token to insert the property value (username or password). Use the {MfaCode} token to insert the MFA code.

Auto Fill

The Auto Fill page allows you to configure automatic form submission for web pages in Royal TS using Web Page connections or using the Royal Passwords browser plugins.

URL (only visible for Credential objects)

You can provide a web page address where this credential should be used.

Elements

A list of HTML INPUT elements found on the web page which can be used to fill out and submit login forms. Select the element to fill, focus or click from the list.

Tip

You can also specify a jQuery selector in the Elements combo box.

Refresh

Click to refresh the list of available HTML elements.

Type

  • Fill: allows you to map a value from the credential (such as username or password) to the selected HTML INPUT element.
  • Click: allows you to perform a click on the selected HTML INPUT element (such as Login or Submit button).
  • Focus: allows you to set the keyboard focus to the selected HTML INPUT element.

Value

Specify a value to map to the selected HTML INPUT element. Use the fly-out button to select replacement tokens to fill in values from the credential object.

Important

Do not enter credentials directly in the auto fill page. Use credentials or credential-assignments and the fly-out button on the right to insert replacement tokens (such as \(EffectiveUsername\), \(EffectivePasswords\), etc.).

Add

Adds the selected element, type and value to the mappings list.

Remove

Removes the selected element, type and value from the mappings list.

Delay (in ms)

Specify the delay in milliseconds before auto fill is executed.

Retry until success

If checked, Royal TS will retry to fill forms in subsequent requests until the auto fill is successful. This setting can be useful when a web page redirects to the login page.

Notes

The Notes page allows you to enter notes for the selected object with HTML formatting, links and embedded images. You can also configure the notes to be inherited from the parent folder.

Use Notes from the parent folder

When selected, Royal TS will display the notes from the parent folder in the notes panel. This option is not available on the document level.

Tip

To embed images, drag them into the editor using drag & drop.

Custom Properties

The Custom Properties page allows you to enter and store additional information for the object. Various data formats are available, including protected fields. You can also group properties by using Header.

Inherit from Parent

When checked, the properties configured on the parent folder are shown but are read-only.

Custom Properties

Use the '+' icon to add a header or a Field or multiple fields based on a template. Click on the label to name the field and enter a value. Click the 'Gear' icon to remove a field or header. The 'Gear' icon also shows additional options, like moving a field up or down.

Custom Fields

The Custom Fields page allows you to enter and store additional information for the object. Custom fields can be used in tasks and templates to inject values from the context connection.

Standard custom fields are also shown in the folder dashboard views and in the properties panel. Protected custom fields can be used to store confidential data (for example when you need an additional password in a task). If you make use of protected custom fields, make sure you encrypt and password protect your document.

Note

Custom fields can be used in Tasks and in the Properties Panel. You can put web page URLs (like an iLO management address) or command lines (such as programs or batch files) in the custom fields and execute them using tasks or directly from the properties panel. Each individual custom field can also be configured to be inherited from the parent folder.

Parent Folder

The Parent Folder page allows you to view or change the parent folder of the selected object. To move multiple objects to another folder use the parent folder page in bulk-edit mode or use the move to command from the Edit tab (see Working with Connections).