Users

Manage BunnyDB user accounts and permissions. All user management endpoints require admin privileges.

List Users

Retrieve a list of all user accounts.

Endpoint

GET /v1/users

Permission: adminOnly

Response

Returns an array of user objects:

Example

curl http://localhost:8112/v1/users \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

[
  {
    "id": 1,
    "username": "admin",
    "role": "admin",
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "id": 2,
    "username": "viewer",
    "role": "viewer",
    "created_at": "2024-01-16T14:22:00Z"
  }
]

Error Responses

Create User

Create a new user account.

Endpoint

POST /v1/users

Permission: adminOnly

Request Body

Response

Example

curl -X POST http://localhost:8112/v1/users \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "username": "readonly-user",
    "password": "secure-password",
    "role": "viewer"
  }'

{
  "id": 3,
  "username": "readonly-user",
  "role": "viewer"
}

Error Responses

Delete User

Delete a user account.

Endpoint

DELETE /v1/users/{username}

Permission: adminOnly

Path Parameters

Response

Example

curl -X DELETE http://localhost:8112/v1/users/readonly-user \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

{
  "deleted": "readonly-user"
}

Error Responses

User Roles

BunnyDB supports two user roles:

Admin Role

Admin users have full access to all API functionality:

• Create, read, update, and delete all resources
• Manage user accounts
• Control mirror operations (pause, resume, resync, retry)
• View logs and status information

Viewer Role

Viewer users have read-only access:

• View peers, mirrors, and their status
• View logs
• View table mappings and available tables
• Cannot create, update, or delete resources
• Cannot control mirror operations
• Cannot manage users

Common Use Cases

Creating a Monitoring User

Create a viewer account for monitoring tools or team members who only need read access:

curl -X POST http://localhost:8112/v1/users \
  -H "Authorization: Bearer <admin-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "monitor",
    "password": "monitor-password",
    "role": "viewer"
  }'

Creating an Operations User

Create an admin account for team members who need to manage replication:

curl -X POST http://localhost:8112/v1/users \
  -H "Authorization: Bearer <admin-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "ops-team",
    "password": "ops-password",
    "role": "admin"
  }'

Auditing Users

List all users to see who has access to the system:

curl http://localhost:8112/v1/users \
  -H "Authorization: Bearer <admin-token>"

Removing Inactive Users

Remove users who no longer need access:

curl -X DELETE http://localhost:8112/v1/users/former-employee \
  -H "Authorization: Bearer <admin-token>"