Credential Inputs

Step 3: Add Credential Inputs

The Credential Inputs section in the System Builder allows you to configure the fields that must be collected from users when they create credentials for a system. This feature enables System Builders to design flexible, secure, and user-friendly credential input experiences.

By default, the host_name field is included as a required field. It is greyed out, cannot be deleted or edited, and will always be collected from users unless the System Builder provides an override value. If the system builder provides the override value, the system will use that value and will not prompt users to enter it.

System Builders can add custom credential fields to collect specific information such as API keys, client secrets, regions, or other parameters.

For Basic Authentication, username and password fields are automatically asked from the system user. You need not manually configure them. Similarly for OAuth1, Consumer Key, Consumer Secret, Access Token, Access Token Secret, Signature Method and an optional realm value are asked from the system user automatically.

When adding a field, the following properties must be configured:

• Display Name is the label shown to end users during credential input. It should be descriptive and easy to understand - for example, “API Key” or “Region.”

• Key is the internal identifier for the field used in backend operations and database storage. It must be unique and must not conflict with built-in keys like host_name. The platform validates key names to prevent duplication or use of reserved keys.

• Type defines how the input is rendered for the user. There are four supported types:

  • input: a standard text input field.

  • mask: a password-style input field that hides the characters typed by the user. The value is obscured in the UI and can be revealed temporarily by clicking an eye icon during credential entry. This is purely a visual masking and does not encrypt or store the data differently.

  • dropdown: a selection list that displays user-friendly labels and stores the corresponding key. For dropdowns, the Options field must contain a valid JSON object. For example, {"in": "India", "eu": "Europe"} will show India and Europe in the dropdown, but store in or eu in the database for further use.

  • Sensitive : It works the same as a mask field. It will be updated in further releases as non-viewable once added. .

• Dropdown Options is a field that is required only when the type is set to dropdown.This field is unnecessary for other field types and should be left blank.

• Override Value allows the System Builder to predefine a fixed value for the field so that the user is not prompted to provide it. Currently, this feature is only supported for the host_name field. If set, the value is automatically applied at credential creation.

• Required is a setting that determines whether the user must fill out the field when creating credentials. It is unchecked by default, but can be checked to make the field mandatory.

Each field can be edited after creation (except for host_name), and custom fields can be removed using the delete icon.

This configuration is crucial for defining what information users must provide and which values can be fixed or pre-set by the System Builder, ultimately simplifying and securing the credential creation process.

Any fields created here can be used using {{inputs.<keyname>}} in APIs.