Skip to main content
All CollectionsTools
Configurations reference
Configurations reference

Configurations establish authentication for web services containing application-specific values or mailbox credentials.

Betty Blocks avatar
Written by Betty Blocks
Updated over a year ago

Warning!

You are reading the legacy document. The described features are only available in the classic-gen. If you're interested in how configurations work in next-gen applications, proceed to this article.

Configurations establish authentication for web services containing application-specific values or mailbox credentials. As configurations are environment dependent, their value is unique for each application. This means that copies or “sandboxes” related to an application are based on a unique configuration.

Accessing Configuration details

1. Open the Tools menu from the Builder Bar.

If you are already in the previous environment, go to Step 3.

2. Select Configuration from the Tools menu.

Note: You may be requested for your login details.

Once completed, please follow from step 3.

3. If the Configuration (A) page is not displayed immediately, open the Tools menu and select Configuration (B).

Creating a new configuration

  1. You can create a new configuration by pressing the New button. A window is opened where you can specify the details for the configuration.

  2. Complete the details such as the name and select the Kind of configuration (A). For example, in the example below, a Client Certification is selected so the details for the Certificate Type (B), a link to the Certificate File, and the Certificate Password details are provided.

Configuration details required

The following details the different kinds of configurations that you can add in the configuration section.

Client Certificate

Client Certificates are required for facilitating connections to web services. You can choose between a Pem certificate or a Pkcs12 certificate.

How to set up a Client Certificate Authentication is explained in HowTo create a Client Certificate set-up

Custom

You can use custom configurations to save environment specific values. This means that different values can be applied throughout your application development street (DTAP).

When a new Custom Configuration is merged to a new environment, it holds no value.

More information about Custom Configurations can be found here: What are sandboxes?

HTTP Basic

You can specify this file type where the webservice you want to connect with HTTP Basic for authentication.

A username and a password is required with this protocol. This generates a Basic Auth token in base64 format.

Mailbox

You can use this configuration for configuring a mailbox service.

You need to specify the mail service's:

- address

- port

- your username and password

More information about mailboxes can be found here: What is a mailbox and HowTo create one?

OAuth1

You can use this kind of configuration to set up web services using OAuth1 to authorize access. Both of the following are required:

- A client key and secret

- A token key and secret.

OAuth2 Basic

You can use this kind of configuration to set up web services using OAuth2 Basic. You have to supply:

- a token credential uri as well as

- a client.

You can specify additional attributes in the fields provided (Extra auth attributes) or use an authorization uri or a client secret.

OAuth2 JWT

This configuration is required when you are using oAuth2 with JSON Web Tokens.

All the fields need to be completed

You have to fill out all of these fields if you’re planning on using an OAuth2 JWT web service.

SSH

You can set up details for SSH authentication that is needed when you are using an SFTP server.

If you set the configuration to:

- use key auth with a generated key (where a key is automatically generated)

- use key auth without a generated key in which case you need to specify a private and a public key.

Editing a configuration

You can edit configurations that you have created for your application. Click on the Tools (A) menu and select Configurations (B). Select a certificate (C) from the list displayed. The certificate details are displayed. Press the Edit (D) to open the details for the certificate. You can edit the certificate details (E) to adjust the details regarding usernames, passwords or API keys.

Press Save (G) to save any changes.

Deleting a configuration

If you are deleting a configuration, you need to first check whether there are any Dependent items. In the example shown, there are no dependencies. Where there are dependencies, you can click the dependent items (F) button to display details.

You can then resolve any dependencies prior to deleting the file.

Once any dependencies are resolved, you can use the Delete button to remove the file.

Note: For more information about dependent items, see What are Dependencies?

Using a configuration

You can use a configuration by selecting it in your web service or other feature. Select the proper authentication type to ensure that you can select the configuration file.



Did this answer your question?