To integrate Connector authentication in your own SaaS product as part of a white label flow, follow the below steps.


Create authentication

Make a POST

  "connector_id": "some uuid4 of the corresponding connector",
  "name": "Test Name",
  "auth_type": "username_password",
  "auth_token": "",
  "auth_details": "",
  "api_endpoint": "sftp://user:password@server_ip/path",
  "user_input": {},
  "username": "user123",
  "password": "password123",
  "tags": [
    "Example Tag",
    "Customer XYZ"

The uuid4 can be received by  making a GET against the connector /v1/connectors?filter=name,like,%22%25ft%25%22 where `ftp` is the connector name.

To use this authentication in a white label flow, pass it's uuid4 you receive in the response as part of the query string as per the example here. So ideally, after creating, you store it on your customer's account or company object in order to use it for all automation flows.

Update authentication

To update, PUT /v1/connector-auths/**uuid4**

  "connector_id":"some uuid4 of the corresponding connector",
  "name":"Test Name",

Get authentication information

To list all auth, To update, PUT /v1/connector-auths/

To GET one: /v1/connector-auths/**uuid4**

Delete authentication

DELETE: /v1/connector-auths/**uuid4**

Limiting access via permissions

You can easily limit the permissions of connector auth e.g. for only one user to be visible in order make storing most secure.