Skip to main content

Create an authentication method

This page explains how to create an authentication method and choose its type. Once created, the method is available in the nodes that support authentication (HTTP(S) Request, FTP, Agent…).

Before you start​

  • Know the type of access to store — see Choose the method type below.
  • If values depend on the environment (URLs, secrets), prepare them as dictionary variables.

Choose the method type​

The type determines what Ecosystem applies automatically at execution time:

TypeWhat Ecosystem doesIdeal for
Basic AuthGenerates the Authorization: Basic … header from a username and password.Access via a username/password pair.
OAuth 2Gets the token, then refreshes it automatically on expiry.Token-based APIs (client_id / client_secret).
API KeyInjects the key into HTTP headers and/or query parameters.API key to send on every call.
CustomRuns a custom script that produces a token and its validity duration.Non-standard authentication server.

For the detailed fields of each type, see Authentication method types.

Create the method​

  1. Click on Authentication methods in the menu.
  2. Click on Add.
  3. Fill in the form:
FieldRequired?Description
NameYesReadable name of the method, used to find it in the nodes.
TypeYesAuthentication family (Basic Auth, OAuth 2, API Key, Custom).
ConfigurationDepending on the typeFields specific to the selected type — see Authentication method types.
  1. Click on Save.
Per-environment configuration

Fill in configurable values (URLs, secrets) with dictionary variables using the format {{dictionaries.nomDuDico.cleDuDico}}: the value is then dynamically resolved according to the execution environment. See Dictionaries.

Result​

The method appears in the authentication methods list, with its values masked. It can be selected in the nodes that support authentication — see Use authentication methods in workflows.

Next steps​

See also: Authentication methods