botbook/src/chapter-10-rest/admin-api.md
Rodrigo Rodriguez (Pragmatismo) 49eb6696ea Reorganize chapters and add admin/user views documentation
Chapter renames:
- chapter-09-api -> chapter-09-tools (LLM Tools)
- chapter-10-api -> chapter-10-rest (REST Endpoints)

New documentation:
- chapter-04-gbui/admin-user-views.md: Complete guide to User vs Admin interfaces
  - User Settings (/api/user/*): profile, security, notifications, storage
  - Admin Panel (/api/admin/*): users, groups, bots, DNS, audit
  - Permission levels: guest, user, manager, admin
  - Desktop sync considerations

Updated:
- Drive app docs with sync feature (rclone, desktop-only)
- All cross-references to renamed chapters
- SUMMARY.md with new structure and admin-user-views entry
2025-12-05 06:50:56 -03:00

1.2 KiB

Admin API

⚠️ Note: This API is not yet implemented and is planned for a future release.

The Admin API will provide endpoints for system administration, user management, and configuration management.

Planned Features

  • System configuration management
  • User and role administration
  • Bot lifecycle management
  • System health monitoring
  • Audit logging and compliance
  • Backup and restore operations

Base URL (Planned)

http://localhost:8080/api/v1/admin

Authentication

Will use the standard BotServer authentication mechanism with administrator-level permissions required.

Endpoints (Planned)

System Configuration

GET /api/v1/admin/config PUT /api/v1/admin/config

User Management

GET /api/v1/admin/users POST /api/v1/admin/users DELETE /api/v1/admin/users/{user_id}

Bot Management

GET /api/v1/admin/bots POST /api/v1/admin/bots/{bot_id}/restart DELETE /api/v1/admin/bots/{bot_id}

System Health

GET /api/v1/admin/health GET /api/v1/admin/metrics

Audit Logs

GET /api/v1/admin/audit

Implementation Status

This API is currently in the planning phase. Check back in future releases for availability.