Manual Guide: Credentials Store¶
The Credentials module functions as a centralized, secure vault within the system to safely store, organize, and manage sensitive access keys, tokens, certificates, and database or stream broker connection strings.
1. Interface & Architecture Overview¶
The Credentials page is designed with a split-screen layout optimized for folder categorization and structured data grids:
- Category Tree Sidebar (Left): A hierarchical directory tree (powered by jsTree) that allows users to organize credentials into custom folder categories. Includes a context menu (right-click) for folder management and badge counters.
- Credentials Data Grid (Right): A DataTables grid listing all stored credentials with filters by Type, Active status, Expiry Date, and columns for tracking metadata.
- Offcanvas Editor (Right Panel): A slide-over panel featuring a dual-tab interface (
DetailsandRelations) used for creating or editing secure entries.
2. Supported Credential Types¶
The system supports multiple security integration types, dynamically adjusting the encrypted payload structure based on the selection:
| Credential Type | Description & Specific Fields |
|---|---|
| API Key | Standard token-based or key-based API authentication. |
| Username Token | Basic user credentials (username, password, token). |
| OAuth Token | Token and authorization secrets for OAuth-enabled services. |
| Database | Database connections (db_type, host, port, database_name, username, password). |
| Stream Broker | Messaging queues like Kafka/RabbitMQ (broker_type, hosts, security_protocol, etc.). |
| SSH Private Key | Secure shell cryptographic keys for remote server execution. |
| Certificate | SSL/TLS certificates with file attachment support (cert_file). |
3. Key Features & Components¶
Category Tree Management¶
- Hierarchical Organization: Structure your secrets into parent and child folders using the + (Add Root) or right-click context menu options.
- Context Actions: Right-click any folder to add sub-folders, rename, or delete categories securely.
Secure Offcanvas Form & Tabs¶
- Details Tab: Manages core inputs including credential name, description, expiry tracking, and active status toggles.
- Relations Tab: A dedicated impact-analysis table that tracks which system components, integrations, or execution pipelines rely on the selected credential.
Import & Export Packages¶
- ZIP Archive Integration: Backup or migrate credential stores securely using JSON/ZIP packages with diff-preview collision checks before committing imports.
4. Standard Table Operations¶
For complete guidelines on how to use standard table utility features (such as ColVis, copying data, Export/Import, Refresh, Bulk Delete, etc.), please refer to the Standard Tables Guide.