Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vigolium.com/llms.txt

Use this file to discover all available pages before exploring further.

Vigolium uses a file-based user system with Bearer token authentication. Each user has a unique access code that serves as their API token.

​
Users and Roles

Users are defined in a JSON file (default: ~/.vigolium/users.json). On first run, the file is auto-created from the embedded template with randomly generated access codes (prefixed vgl_). Three roles control API access:
RoleDescription
adminFull access — can delete resources, update config, manage projects
operatorCan run scans, ingest traffic, and execute agent operations
viewerRead-only access to records, findings, stats, and scan history
Default users created on bootstrap:
NameRole
vigolium-adminadmin
vigolium-operatoroperator
vigolium-analystviewer
vigolium-auditorviewer

​
Login

Exchange a username and access code for user info and a Bearer token.

​
POST /api/auth/login

This endpoint is publicly accessible (no authentication required). Request body: 
{
  "username": "vigolium-admin",
  "access_code": "vgl_abc123..."
}
Success response (200): 
{
  "token": "vgl_abc123...",
  "user": {
    "uuid": "d4f5e6a7-...",
    "name": "vigolium-admin",
    "email": "",
    "role": "admin"
  }
}
Error responses:
StatusConditionBody
400Missing or malformed request body{"error": "username and access_code are required", "code": 400}
401Invalid username or access code{"error": "invalid username or access code", "code": 401}

​
Current User Info

Retrieve the authenticated user’s identity and role.

​
GET /api/user/info

Requires a valid Bearer token. Success response (200): 
{
  "uuid": "d4f5e6a7-...",
  "name": "vigolium-admin",
  "email": "",
  "role": "admin"
}
Error responses:
StatusConditionBody
401Missing or invalid token{"error": "invalid Bearer token", "code": 401}

​
Using the Token

Include the token as a Bearer token in the Authorization header for all subsequent API requests: 
curl -H "Authorization: Bearer vgl_abc123..." http://localhost:9002/api/info

​
Disabling Authentication

Set no_auth: true in vigolium-configs.yaml or pass the --no-auth flag to the server command to disable authentication entirely. This is not recommended for production use.