Application credentials configuration
What this step is for​
Defines the form that people fill in when they connect (register) this application in Canvas: for example a user name and password, an API key, or an environment to connect to.
Whatever they type here is kept safely and handed to the next step, Authentication, which uses it to log in to the application for them.
Triggered by: Application registration (the credentials form).
What you see on the page​
| Item | What it does |
|---|---|
| Instructions (HTML) | A short text shown above the form. Tell users where to find the values, for example "Open Settings > API and copy your key". Basic HTML such as <p>, <b>, <a href="..."> works. |
| Fields Constructor | Build the form field by field. |
| JSON editor | The same form as text. Handy to copy fields between applications. The two views stay in sync: a change in one shows up in the other. |
| Add new field | Adds a field to the form. |
| Delete (on a field) | Removes the field. |
Settings of a field​
| Setting | What to enter |
|---|---|
| Name | The label users see, for example API key. |
| Description | A short hint shown with the field, for example Your personal API key. |
| Short name | A short identifier without spaces, for example apikey. You use it later in your scripts as config.apikey. Do not change it once users have connected the application. |
| Control type | How the field looks: Text, Password, Select (a list to choose from), Username, Bool (yes / no), Token. |
| Optional | Yes: the user may leave it empty. No: the user must fill it in before the application can be connected. |
| Default value | A value filled in for the user in advance. Do not put real secrets here. |
| Encrypted and hidden | Yes: the value is masked on screen. Use it for passwords, keys and tokens. |
| Options (only for Select) | The list of choices, written as value|Label separated by commas, for example live|Live environment,test|Test environment. |
Example​
You connect an application that needs a user name, a password and the choice of environment. Add three fields:
| Name | Short name | Control type | Optional | Encrypted and hidden | Options |
|---|---|---|---|---|---|
| Username | username | Text | No | No | |
| Password | password | Password | No | Yes | |
| Environment | env | Select | No | No | live|Live,test|Test |
In the next step you can then use the answers like this:
config.username
config.password
config.env
Good to know​
- The answers are available only in the Authentication step (the Authentication script, the Token Refresh script and
the Post Handler). The later steps cannot see them. If a later step needs a value, save it from the Post Handler to
appVault(settings) orappVaultSecret(secrets). - If you use OAuth to log in, users are sent to the application's own sign-in page, so this form is usually short: only what you need before the redirect, for example a region or a tenant name.
- Keep field names clear and add a description to every field that may confuse users.