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:

Example of an error from "More Details"

The user can view the error message returned by the API, update the credentials and try again, or choose to save the Connector Auth despite the error by clicking the Save Regardless button.

To enable this functionality, the endpoint must be specified 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

Edit Connector > Auth Configuration

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 a regular action, so the base domain should not be specified.

This (currently) needs to be a GET endpoint to keep the configuration as simple as possible and to prevent accidental creation of anything in the customer’s account.

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

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