Credentials are secure object in IMSURGE that store authentication details (such as API keys, usernames, or tokens) required to access an external system. Their primary purpose is to let you reuse the same authentication details across multiple Integrations and pipelines without needing to re-enter them.

How Credentials Fit into the Workflow

Credentials are the first step in enabling any data flow. Integrations rely on Credentials to authenticate, and pipelines rely on Integrations.

flowchart TD
    A[Step 1: Create Credentials] --> B[Step 2: Create Integration]
    B --> C[Step 3: Create Pipeline]

Managing Credentials

You can manage all of your stored authentication details from the Settings › Credentials tab in the IMSURGE UI.

  • Create Credentials: Navigate to Settings › Credentials › + Credentials, choose the vendor, and enter the required authentication fields. It is best practice to use a descriptive name (ex. Aeroqual Production API).
  • Edit Credentials: If a token expires or a password changes, update the Credentials in one place. All Integrations using them will automatically use the updated values on their next run.
  • Delete Credentials: Remove Credentials that are no longer needed to keep your workspace organized.

Reference

The specific fields required for a set of Credentials (e.g., API Key, User ID, Password) vary for each vendor.

For a complete list of required credentials for a specific system, please refer to that system’s guide in the Integration Library.

AspectDetails
EncryptionAll secrets stored in Credentials are encrypted at rest and cannot be viewed in the UI after saving.
PermissionsAssign only the minimum level of permissions required for the integration. Avoid using administrator-level keys unless necessary.