Skip to content

README.md

Latest commit

 

History

History
256 lines (214 loc) · 5.95 KB

README.md

File metadata and controls

256 lines (214 loc) · 5.95 KB

Databunkerpro JavaScript Client

A JavaScript client library for interacting with the Databunkerpro API.

Installation

npm install databunkerpro-js

Usage

CommonJS

const DatabunkerproAPI = require('databunkerpro-js');

const client = new DatabunkerproAPI('https://your-databunker-instance.com', 'your-token');

ES Modules

import DatabunkerproAPI from 'databunkerpro-js';

const client = new DatabunkerproAPI('https://your-databunker-instance.com', 'your-token');

Examples

Creating a User

const profile = {
  email: "user@example.com",
  name: "John Doe"
};

const options = {
  groupname: "users",
  rolename: "basic-user"
};

const requestMetadata = {
  source: "web-signup",
  ip_address: "192.168.1.1",
  user_agent: "Mozilla/5.0"
};

try {
  const result = await client.createUser(profile, options, requestMetadata);
  console.log(result);
} catch (error) {
  console.error(error);
}

Adding User to Group

const requestMetadata = {
  approver: "admin@example.com",
  reason: "Role promotion"
};

// Using group name and role name
await client.addUserToGroup(
  "email",                // mode
  "user@example.com",     // identity
  "admins",              // groupname (string)
  "editor",              // rolename (optional)
  requestMetadata
);

// Using group ID and role ID
await client.addUserToGroup(
  "email",                // mode
  "user@example.com",     // identity
  123,                    // groupname (numeric ID)
  456,                    // rolename (numeric ID, optional)
  requestMetadata
);

Managing Legal Basis and Agreements

// Create a legal basis for data processing
const marketingConsent = await client.createLegalBasis({
  brief: 'marketing-consent',
  status: 'active',
  module: 'marketing',
  fulldesc: 'Consent for marketing communications',
  shortdesc: 'Marketing Consent',
  basistype: 'consent',
  requiredmsg: 'Required for receiving promotional content',
  requiredflag: false
});

// Record user's acceptance of an agreement
const acceptance = await client.acceptAgreement(
  'email',
  'user@example.com',
  {
    brief: 'marketing-consent',
    agreementmethod: 'web-form',
    referencecode: 'REF123',
    starttime: '1d',
    finaltime: '100d',
    status: 'active',
    lastmodifiedby: 'admin@company.com'
  }
);

// Cancel an agreement
await client.cancelAgreement('email', 'user@example.com', 'marketing-consent');

// Get user's agreement status
const agreement = await client.getUserAgreement('email', 'user@example.com', 'marketing-consent');

// List all user's agreements
const agreements = await client.listUserAgreements('email', 'user@example.com');

Using Request Metadata for Context-Aware Access Control

// Example of using request metadata for policy validation
const requestMetadata = {
  location: "HQ Office",
  device_type: "company_laptop",
  access_time: "2024-03-15T09:00:00Z"
};

// Fetch user data with context
const userData = await client.getUser("email", "user@example.com", requestMetadata);

// Update user profile with context
const updateResult = await client.updateUser(
  "email",
  "user@example.com",
  { department: "Sales" },
  requestMetadata
);

Managing Database Connectors

// List supported connector types
const supportedConnectors = await client.listSupportedConnectors();

// Create a MySQL database connector
const mysqlConnector = await client.createConnector({
  connectorname: "MySQL Production",
  connectortype: "mysql",
  connectordesc: "Production user database",
  username: "admin",
  apikey: "api-key-123",
  dbhost: "prod-db.example.com",
  dbport: 3306,
  dbname: "users",
  status: "active"
});

// Create a PostgreSQL database connector
const pgConnector = await client.createConnector({
  connectorname: "PostgreSQL Analytics",
  connectortype: "postgresql",
  connectordesc: "Analytics database for user behavior",
  username: "analyst",
  apikey: "pg-api-key",
  dbhost: "analytics.example.com",
  dbport: 5432,
  dbname: "analytics",
  status: "active"
});

// Update connector configuration
await client.updateConnector({
  connectorid: "connector-123",
  connectorname: "MySQL Production Updated",
  connectortype: "mysql",
  apikey: "new-api-key",
  dbhost: "new-prod-db.example.com",
  status: "active"
});

// Validate connector connectivity
await client.validateConnectorConnectivity({
  connectorid: "connector-123",
  apikey: "new-api-key"
});

// Get table metadata
await client.getTableMetadata({
  connectorid: "connector-123",
  dbname: "users",
  tablename: "user_data"
});

// Get user data from connector
const userData = await client.connectorsGetUserData(
  "email",
  "user@example.com",
  "connector-123"
);

// Get additional user data from connector
const extraData = await client.connectorsGetUserExtraData(
  "email",
  "user@example.com",
  "connector-123"
);

// Delete user data from connector
await client.connectorsDeleteUser(
  "email",
  "user@example.com",
  "connector-123"
);

System Operations

// Get system statistics
const stats = await client.getSystemStats();
console.log('System stats:', stats);

// Generate wrapping key from three Shamir's Secret Sharing keys
const wrappingKeyResult = await client.generateWrappingKey(
  'shamir-key-1',
  'shamir-key-2',
  'shamir-key-3'
);
console.log('Generated wrapping key:', wrappingKeyResult.wrappingkey);

// Get system metrics (Prometheus format)
const metrics = await client.getSystemMetrics();
console.log('System metrics:', metrics);

API Reference

The library provides methods for interacting with all Databunkerpro endpoints:

  • User Management
  • App Data Management
  • Agreement Management (Legal Basis & Consent)
  • Connector Management
  • Group Management
  • Token Management
  • Audit Management
  • Tenant Management
  • Role Management
  • Policy Management
  • System Operations

For detailed API documentation, please visit our API Documentation.

License

MIT