dify_admin/docs/api/README.md

55 lines
1.4 KiB
Markdown

# Dify Admin API Documentation
## Overview
This documentation covers the core API modules of the Dify Admin system. Each module provides specific functionality for managing the administration platform.
## Module Documentation
### [Account Management](account_manager.md)
- User account creation and management
- Password hashing and verification
- Tenant association
### [Tenant Management](tenant_manager.md)
- Workspace/tenant creation
- RSA key pair generation
- Tenant search and retrieval
### [Model Management](model_manager.md)
- AI model configuration
- Model encryption and storage
- Bulk operations
### [Provider Management](provider_manager.md)
- AI service provider management
- API key encryption
- Provider configuration
### [Database Operations](database.md)
- Connection pooling
- SQL execution helpers
- Database initialization
### [Operation Logging](operation_logger.md)
- Audit trail recording
- Log querying
- Log maintenance
### [Encryption Services](encryption.md)
- Hybrid encryption (RSA + AES)
- Key management
- API key protection
## Getting Started
To use these APIs, import the required module and instantiate the appropriate class:
```python
from api.account_manager import AccountManager
account_mgr = AccountManager()
```
## Security Notes
- All sensitive operations use encryption
- API keys are never stored in plaintext
- Detailed logging for audit purposes