credential-reader

An n8n community node that reads any installed credential type, including MongoDB and community credentials.

Package Information

Released: this month
Downloads: 0 weekly / 0 monthly
Latest Version: 1.2.1
Author: n8n Credential Reader contributors

Documentation

n8n-nodes-credential-reader

This n8n community node outputs the decrypted fields of an existing built-in
n8n credential. The package generates declarations for n8n's built-in
credential catalog at build time, so the selector includes:

  • built-in credentials, including MongoDB (mongoDb).

Credentials contributed by other community-node packages are visible in n8n's
generic credential selector, but this node cannot read them. n8n only grants
wildcard credential access to its own HTTP Request node types; community nodes
must declare every supported credential type at build time.

Security warning

This node deliberately copies decrypted secrets into normal execution data.
Execution data can be stored, displayed, exported, or accessed by other workflow
users and nodes. Use it only on a trusted self-hosted n8n instance.

Recommended precautions:

  • restrict access to workflows and executions that use this node;
  • disable successful execution-data saving for affected workflows;
  • avoid sending its output to logs, error workflows, or external services; and
  • delete historical execution data after testing.

Installation

Install the package from Settings > Community Nodes after publishing it, or
install it in the community-nodes directory of a self-hosted n8n instance:

npm install n8n-nodes-credential-reader

Restart n8n after installation.

Usage

  1. Add Credential Reader to a workflow.
  2. Select a credential type, such as MongoDB.
  3. Select or create the credential instance in the credential control shown by
    n8n.
  4. Run the workflow.

The node returns:

{
  "credentialType": "mongoDb",
  "credentials": {
    "configurationType": "connectionString",
    "connectionString": "mongodb://...",
    "database": "example"
  }
}

Enable Include Input Data to include the incoming item's JSON under input.

Compatibility

The all-credential selector relies on n8n's current credentialsSelect
filtering behavior. The package targets n8n's Node API version 1 and is built
against n8n-workflow 2.16.

Development

npm install
npm test
npm run lint

The list of declared built-in credential types lives in
nodes/CredentialReader/builtinCredentialTypes.ts. It is generated from a
published n8n-nodes-base tarball and committed, so a normal build needs no
extra dependencies. To target a newer n8n release, regenerate it:

npm run credentials:refresh          # latest
npm run credentials:refresh 2.15.1   # a specific version

Discussion