Faros uses Connections for source authentication. You can set up these connections while adding a new source or through the Connections page. This page provides a centralized location to view and manage all your connections, including information on their last modification. Editing a connection automatically updates the authentication details for all sources linked to it. Deleting a connection, however, will cease data retrieval for any source using that connection. Additionally, you have the flexibility to create multiple connections for the same source, each with distinct permissions, allowing for tailored access control.

To set up a new connection, start by assigning a unique name and selecting the source type.

When you connect a specific source, you'll notice additional fields that may appear, as certain sources necessitate a particular set of permissions for Faros to successfully authenticate. To determine the required permissions, place your cursor over the help icon located next to the credential (e.g., API key or token) input field. For certain connections, Faros will verify the scope of your credentials. However, you have the option to bypass these verification checks by toggling Validate connection off.

Once your credentials are verified, for certain connections, you'll encounter additional prompts. For instance, with GitHub, you'll need to select or manually input the GitHub organizations you wish to sync data for.

Once you have created a connection, all future sources can use it to authenticate.

API token requirements

Faros uses API tokens to periodically pull metadata; define token expiration according to your company policy and automation.