Skip to main content

Credential Manager

This document details the internal procedures for setting up and managing SFTP connections using the Credential Manager.

1. Initial SFTP Entry Configuration​

Before provisioning an SFTP connection, the following parameters must be submitted to the e123 team:

  • File Identifier: The designated file name for which the SFTP connection is being established.
  • Server URL: The target server’s address.
  • Port Number: Typically, port 22 (default).
  • Protocol: SFTP is the default protocol.
  • SSH Key: If SSH key authentication is required, the corresponding key must be provided.
  • PGP Key: For encrypted file transfers using PGP, supply the relevant key.

These details are necessary for the initial creation of the SFTP entry by e123.

2. Credential Manager Interface​

After the SFTP entry is provisioned, users can access the Credential Manager via the settings menu. The interface displays all configured SFTP connections for the organization, providing an overview for internal monitoring and management.

3. SFTP Connection Management​

Within the Credential Manager, administrators can perform the following actions:

  • Edit SFTP Entries: Update or add credentials including username, password, and remote folder path for each SFTP connection.
  • Connection Validation: Utilize the “Test Connection” feature post-update to verify the integrity of the SFTP credentials. The system initiates a connection attempt to confirm proper configuration.

4. Connection Testing and Error Handling​

  • Successful Connection: A successful test results in:

    • Storage of the SFTP configuration.
    • Activation of the new credentials, which are then utilized by the e123 system for SFTP operations.

  • Failed Connection: A failure during testing will:

    • Display an error message indicating the issue.
    • Keep the credentials inactive until the problem is resolved.

Common Issues and Diagnostics​

  • IP Whitelisting: A timeout error typically indicates that the connection attempt originated from an IP address that is not whitelisted on the server.
  • Credential Mismatches: Authentication errors should prompt verification of the provided username and password.

5. Escalation and Support​

For unresolved errors:

  • Open a support ticket with e123.
  • Include the specific file identifier and the error message displayed.
  • The support team will analyze logs and assist with troubleshooting, including verification of IP whitelisting and credential correctness.