Connector Auth Validation

The automatic Connector Auth validation feature automatically checks whether the credentials for a Connector Auth are correct or not during the creation of a it.

Feature Introduction

The automatic Connector Auth validation feature automatically checks whether the credentials for a Connector Auth are correct or not during the creation of a it:

The user can see the error message returned by the API, edit the credentials and check again, or choose to save the Connector Auth regardless of it.

In order for this to work, we need to specify the endpoint that should be used for this in the Authentication Configuration of the corresponding connector.

As the authentication process for OAuth2 and refreshable token implicitly check whether the credentials are correct, the explicit validation does not have to and cannot be used with them.

Configuration on connector

In the Authentication Configuration a new field called test_endpoint needs to be added, which specifies the endpoint.

This endpoint is the same as in regular action, thus the base domain should not be specified.

This (currently) needs to be a GET endpoint, in order to keep the configuration as simple as possible and to prevent accidental creation of anything in the customers' accounts.

When the user adds a connector auth we send a request to that endpoint with the user's credentials and, if specified, their basedomain.

For Helpers we need to code the validation in the backend, as of now we only saw a use case to have a validation for the FTP and SQL Helper (this just checks the connection, kind of like a ping to the respective server), but this can be expanded in case it makes sense.

Last updated