Skip to main content

Authorization

Follow this guide to create a new FireHydrant credential that will allow Nexla to authenticate to and exchange data with your FireHydrant account.
fire_hydrant_api_auth.png

FireHydrant

Prerequisites​

To connect Nexla to FireHydrant, you need a FireHydrant API key. FireHydrant uses Bearer token authentication for all API requests, and API keys are scoped to your organization. Only users with Owner permissions in FireHydrant can create API keys.

Obtain a FireHydrant API Key​

FireHydrant API keys are generated from the Settings area of the FireHydrant application.

  1. Log in to your FireHydrant account at app.firehydrant.io.

  2. Click Settings in the left-hand navigation panel.

  3. Under the Integrations section, select API Keys.

  4. Click the + Create API key button.

  5. Enter a descriptive Name for the key (for example, Nexla Integration) and, optionally, a Description to help identify its purpose.

  6. Click Save to generate the key.

  7. On the confirmation page, copy the API key displayed and store it in a secure location.

Important

The API key is shown only once immediately after creation. If you navigate away without copying it, you will need to create a new key. Store the key in a secrets manager or other secure credential store.

For complete details about managing FireHydrant API keys, refer to the FireHydrant API Keys documentation.

Create a FireHydrant Credential​

  • To create a new FireHydrant credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

FireHydrant authenticates all API requests using a Bearer token transmitted in the Authorization request header. Nexla sends this header automatically once the API key is saved in the credential.

  1. Enter your FireHydrant API key in the API Key Value field. This is the token you copied when creating the key in Settings > API Keys within FireHydrant.

    The API key value is stored securely and is not displayed after the credential is saved. Nexla validates the key against the FireHydrant API (using the /v1/environments endpoint) before saving the credential.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.