Credential Management

This example covers creating, testing, updating, transferring, and deleting credentials using the CredentialClient.

---

import N8nClient from '@egose/n8n-client';

const client = new N8nClient({
  baseUrl: process.env.N8N_BASE_URL || 'http://localhost:5678',
  apiKey: process.env.N8N_API_KEY,
});

// ─── Create Credentials ─────────────────────────────────────────────────────

const apiKeyCred = await client.credentials().create({
  name: 'Service API Key',
  type: 'httpHeaderAuth',
  data: {
    headerName: 'X-API-Key',
    headerValue: 'my-secret-key',
  },
});
console.log(`Created API key credential: ${apiKeyCred.id}`);

const dbCred = await client.credentials().create({
  name: 'PostgreSQL Connection',
  type: 'postgresDb',
  data: {
    host: 'localhost',
    port: 5432,
    database: 'mydb',
    user: 'admin',
    password: 'secret', // pragma: allowlist secret
  },
  projectId: 'proj-123',
});
console.log(`Created DB credential: ${dbCred.id}`);

// ─── List Credentials ───────────────────────────────────────────────────────

const { data: credentials } = await client.credentials().list({ limit: 20 });
console.log(`Total credentials: ${credentials.length}`);

// ─── Test Credentials ───────────────────────────────────────────────────────

const testResult = await client.credentials().test(apiKeyCred.id);
if (testResult.success) {
  console.log('API key credential is valid');
} else {
  console.log(`Credential test failed: ${testResult.message}`);
}

// ─── Update Credentials ─────────────────────────────────────────────────────

const updated = await client.credentials().update(apiKeyCred.id, {
  name: 'Production API Key',
  data: {
    headerName: 'X-API-Key',
    headerValue: 'production-secret-key',
  },
});
console.log(`Updated credential: ${updated.name}`);

// ─── Get Credential Schema ──────────────────────────────────────────────────

const schema = await client.credentials().getSchema('httpHeaderAuth');
console.log('HTTP Header Auth schema:', Object.keys(schema));

// ─── Transfer Credential ────────────────────────────────────────────────────

await client.credentials().transfer(dbCred.id, 'target-project-id');
console.log('Credential transferred to another project');

// ─── Delete Credential ──────────────────────────────────────────────────────

const deleted = await client.credentials().delete(apiKeyCred.id);
console.log(`Deleted credential: ${deleted.id}`);