WebGuard Backend Documentation

WebGuard Backend is a Node.js/Express service responsible for:

validating FireAPI SSO sessions

syncing user profiles into local database

issuing tool-specific access tokens

providing protected API endpoints

🚀 Installation

⚙️ Environment Setup

Create .env file:

Required variables

DATABASE_URL → MySQL/PostgreSQL connection string

FIREAPI_BACKEND_URL → FireAPI main backend URL (example: http://localhost:8000)

FRONTEND_URL → WebGuard frontend URL (example: http://localhost:5007)

PORT → Backend port (default: 4010)

🗄️ Database Initialization (Prisma)

▶️ Run Development Server

🔑 FireAPI SSO Flow (Backend)

How it works

User opens tool from FireAPI dashboard

FireAPI redirects user with token

WebGuard backend calls FireAPI verify endpoint

FireAPI returns metadata (user, toolId, plan)

WebGuard syncs user into local database

Backend returns a local session for frontend

⭐ Main SSO Endpoint

`POST /api/users/sso-login`

Body:

{
  "token": "string",
  "userData": {}
}

Purpose:

authenticates FireAPI user

creates or updates user record

returns local session response

🛠️ Backend API Endpoints

Users & Authentication

Method	Endpoint	Description
POST	`/api/users/sso-login`	FireAPI SSO login
POST	`/api/users/verify`	Internal token verification
GET	`/api/users`	List all users (Admin)
DELETE	`/api/users/:id`	Revoke user access

Tool Tokens

Method	Endpoint	Description
POST	`/api/tokens`	Issue new API token
GET	`/api/tokens/check-status/:id`	Token status check

📂 Backend Structure

src/
├── controllers/    # Users and Tokens logic
├── routes/         # Express routes
├── utils/          # Prisma client, Logger
└── index.ts        # Middleware + server entry

💡 Tips

If CORS fails, ensure FRONTEND_URL matches the browser URL.

Use npx prisma studio to debug DB records easily.

WebGuard Backend Documentation

🚀 Installation#

⚙️ Environment Setup#

Required variables#

🗄️ Database Initialization (Prisma)#

▶️ Run Development Server#

🔑 FireAPI SSO Flow (Backend)#

How it works#

⭐ Main SSO Endpoint#

POST /api/users/sso-login#

🛠️ Backend API Endpoints#

Users & Authentication#

Tool Tokens#

📂 Backend Structure#

💡 Tips#