Skip to main content

Security Configurations

A security configuration is basically just a convenient way to store adapter and logging credentials. This gives customers the ability to securely store credentials and reuse them on multiple integrations. This page describes how to create a security configuration.

Creating a Security Configuration​

Navigate to "Security Configurations" in the right hand menu and click "Add new configuration". Your are then greeted by a select menu where you will choose what kind of configuration you want to create. The possible options are:

  • Webhook: Used for Http/Rest adapters, data collection and webhook logging
  • Archeo: Credentials for Archeo logging
  • SFTP: Credentials for SFTP adapters
  • FTP: Credentials for FTP adapters
  • Connection String: Used for Azure Storage, Service Bus and Event Grid adapters

Webhook​

When selecting Webhook, you'll first encounter three fields:

img

  • Name: The name that pops up when you select the configuration on an integration.
  • Apim Subscription Key: Convenience field for adding Ocp-Apim-Subscription-Key.
  • Authorization Header Type: Select the protocol used by your endpoint

Add values as needed for your HTTP resource. If you need to add headers you can do this in the integration configurations itself.

Choosing your authentication scheme​

We supply thee authentication schemes in ConnXio (CX):

OAuth 2.0​

Oauth is an established standard for authentication between systems. We won't be going into detail on how to manage and use Oauth 2.0 here as this is an advanced security topic. To configure the Oauth parameters you enter information as described below:

img

Please refer to the Oauth 2.0 standard for more information about the fields.

Basic​

This is regular basic auth. Add username and password without encoding, we will encode before sending the request.

Header or custom​

To configure header or custom security please add the header in the "header" options on each usage of the security configuration. We will be adding header security as an option at a later date.

Archeo​

In addition to to the name, the Archeo security config only holds one field:

img

  • Name: The name that pops up when you select the configuration on an integration.
  • Archeo API Key: The Archeo API Key provided from Archeo, used when logging to Archeo.

Sftp​

The SFTP configuration contains all the relevant properties for connection to the SFTP server. The path to witch folder to connect to is set on the adapter.

img

  • Name: The name that pops up when you select the configuration on an integration.
  • Url: The url to the SFTP server. The url support port number of suffixed with a colon, ie: sftp-server.net:1337
  • Username: The username CX uses to authenticate to server.
  • Password: The password CX uses to authenticate to server.
  • SSH HostKey Fingerprint: The fingerprint of the server certificate. Read more in the WinScp documentation.

Ftp​

The FTP configuration contains all the relevant properties for connection to the SFTP server. The path to witch folder to connect to is set on the adapter.

img

  • Name: The name that pops up when you select the configuration on an integration.
  • Url: The url to the FTP server. The url support port number of suffixed with a colon, ie: ftp-server.net:1337.
  • Username: The username CX uses to authenticate to server.
  • Password: The password CX uses to authenticate to server.

Connection String​

This Connection String Security Config is used wherever a Connection String is to be used. This could be a Azure Storage adapter, ServiceBus adapter or a Event Grid adapter.

img

  • Name: The name that pops up when you select the configuration on an integration.
  • Connection String: The connection string for the relevant resource.