# 0xkoat/backend-gerance architecture

> Architecture diagram of the GitHub repository 0xkoat/backend-gerance, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/0xkoat/backend-gerance
- Repository: https://github.com/0xkoat/backend-gerance

## Overview

SecOps is a multi-tenant API for provisioning users and tenants, controlling access to external security tools, and providing ticketing with stored and live notifications. The main workflow is: a user authenticates, platform and tenant administrators configure subscriptions and endpoints, and an authorized user launches a module via redirect; users can also raise tickets and receive updates. PostgreSQL stores tenant-scoped records and audit/notification state. The graph reflects README-documented behavior and shown source references; some subsystem internals were not sampled, so uncertain links are omitted.

Main entry points: [`src/prisma/prisma.service.ts`](https://github.com/0xkoat/backend-gerance/blob/main/src/prisma/prisma.service.ts) (Prisma Client), [`src/module-access/module-access.service.ts`](https://github.com/0xkoat/backend-gerance/blob/main/src/module-access/module-access.service.ts) (Module Access), [`src/auth/auth.service.ts`](https://github.com/0xkoat/backend-gerance/blob/main/src/auth/auth.service.ts) (Authentication), [`src/tickets/tickets.service.ts`](https://github.com/0xkoat/backend-gerance/blob/main/src/tickets/tickets.service.ts) (Ticket Management)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_identity["Identity &amp; Users"]
  node_auth_api["Auth API<br/>[auth.controller.ts]"]
  node_auth_logic["Authentication<br/>[auth.service.ts]"]
  node_jwt["JWT Strategy<br/>[jwt.strategy.ts]"]
  node_user_api["User API"]
  node_users["User Management<br/>[users.service.ts]"]
end

subgraph group_administration["Tenant Administration"]
  node_tenant_api["Tenant API"]
  node_tenants["Tenant Management<br/>[tenants.service.ts]"]
end

subgraph group_modules["Module Access"]
  node_module_api["Module APIs"]
  node_endpoint_api["Endpoint Admin API"]
  node_module_access["Module Access"]
  node_level_rules["Analyst Level Rules<br/>[module-levels.ts]"]
end

subgraph group_support["Tickets &amp; Events"]
  node_ticket_api["Ticket API"]
  node_tickets["Ticket Management<br/>[tickets.service.ts]"]
  node_notifications["Notifications"]
  node_events_api["Live Event API"]
  node_events["Event Delivery<br/>[events.service.ts]"]
end

subgraph group_storage["Persistence"]
  node_prisma["Prisma Client<br/>[prisma.service.ts]"]
  node_postgres[("PostgreSQL")]
end

node_client(("Frontend BFF"))
node_module_products["Security Modules"]

node_client -->|"requests auth"| node_auth_api
node_auth_api -->|"calls"| node_auth_logic
node_auth_logic -->|"looks up users"| node_users
node_auth_logic -->|"manages refresh tokens"| node_prisma
node_auth_logic -->|"builds claims"| node_jwt
node_client -->|"manages accounts"| node_user_api
node_user_api -->|"calls"| node_users
node_users -->|"reads and writes"| node_prisma
node_client -->|"administers tenants"| node_tenant_api
node_tenant_api -->|"calls"| node_tenants
node_tenants -->|"reads and writes"| node_prisma
node_client -->|"requests module launch"| node_module_api
node_module_api -->|"dispatches access"| node_module_access
node_endpoint_api -->|"manages endpoints"| node_module_access
node_module_access -->|"checks levels"| node_level_rules
node_module_access -->|"checks access and records launches"| node_prisma
node_module_access -->|"redirects to configured product"| node_module_products
node_client -->|"raises and tracks tickets"| node_ticket_api
node_ticket_api -->|"dispatches ticket actions"| node_tickets
node_tickets -->|"creates notifications"| node_notifications
node_tickets -->|"stores tickets"| node_prisma
node_notifications -->|"stores notifications"| node_prisma
node_notifications -->|"publishes updates"| node_events
node_client -->|"opens event stream"| node_events_api
node_events_api -->|"streams events"| node_events
node_events -->|"persists application state"| node_postgres
node_prisma -->|"queries"| node_postgres

click node_auth_api "https://github.com/0xkoat/backend-gerance/blob/main/src/auth/auth.controller.ts"
click node_auth_logic "https://github.com/0xkoat/backend-gerance/blob/main/src/auth/auth.service.ts"
click node_jwt "https://github.com/0xkoat/backend-gerance/blob/main/src/auth/jwt.strategy.ts"
click node_user_api "https://github.com/0xkoat/backend-gerance/blob/main/src/users/users.controller.ts"
click node_users "https://github.com/0xkoat/backend-gerance/blob/main/src/users/users.service.ts"
click node_tenant_api "https://github.com/0xkoat/backend-gerance/blob/main/src/tenants/tenants.controller.ts"
click node_tenants "https://github.com/0xkoat/backend-gerance/blob/main/src/tenants/tenants.service.ts"
click node_module_api "https://github.com/0xkoat/backend-gerance/blob/main/src/module-access/modules.controller.ts"
click node_endpoint_api "https://github.com/0xkoat/backend-gerance/blob/main/src/module-access/module-endpoints.controller.ts"
click node_module_access "https://github.com/0xkoat/backend-gerance/blob/main/src/module-access/module-access.service.ts"
click node_level_rules "https://github.com/0xkoat/backend-gerance/blob/main/src/module-access/module-levels.ts"
click node_ticket_api "https://github.com/0xkoat/backend-gerance/blob/main/src/tickets/tickets.controller.ts"
click node_tickets "https://github.com/0xkoat/backend-gerance/blob/main/src/tickets/tickets.service.ts"
click node_notifications "https://github.com/0xkoat/backend-gerance/blob/main/src/tickets/notifications.service.ts"
click node_events_api "https://github.com/0xkoat/backend-gerance/blob/main/src/events/events.controller.ts"
click node_events "https://github.com/0xkoat/backend-gerance/blob/main/src/events/events.service.ts"
click node_prisma "https://github.com/0xkoat/backend-gerance/blob/main/src/prisma/prisma.service.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_auth_api,node_auth_logic,node_jwt,node_user_api,node_users,node_client toneBlue
class node_tenant_api,node_tenants toneAmber
class node_module_api,node_endpoint_api,node_module_access,node_level_rules toneMint
class node_ticket_api,node_tickets,node_notifications,node_events_api,node_events toneRose
class node_prisma,node_postgres,node_module_products toneIndigo
```

## Components

### Identity & Users

- [Auth API](https://github.com/0xkoat/backend-gerance/blob/main/src/auth/auth.controller.ts): `src/auth/auth.controller.ts`
- [Authentication](https://github.com/0xkoat/backend-gerance/blob/main/src/auth/auth.service.ts): `src/auth/auth.service.ts`
- [JWT Strategy](https://github.com/0xkoat/backend-gerance/blob/main/src/auth/jwt.strategy.ts): `src/auth/jwt.strategy.ts`
- [User API](https://github.com/0xkoat/backend-gerance/blob/main/src/users/users.controller.ts): `src/users/users.controller.ts`
- [User Management](https://github.com/0xkoat/backend-gerance/blob/main/src/users/users.service.ts): `src/users/users.service.ts`

### Tenant Administration

- [Tenant API](https://github.com/0xkoat/backend-gerance/blob/main/src/tenants/tenants.controller.ts): `src/tenants/tenants.controller.ts`
- [Tenant Management](https://github.com/0xkoat/backend-gerance/blob/main/src/tenants/tenants.service.ts): `src/tenants/tenants.service.ts`

### Module Access

- [Module APIs](https://github.com/0xkoat/backend-gerance/blob/main/src/module-access/modules.controller.ts): `src/module-access/modules.controller.ts`
- [Endpoint Admin API](https://github.com/0xkoat/backend-gerance/blob/main/src/module-access/module-endpoints.controller.ts): `src/module-access/module-endpoints.controller.ts`
- [Module Access](https://github.com/0xkoat/backend-gerance/blob/main/src/module-access/module-access.service.ts): `src/module-access/module-access.service.ts`
- [Analyst Level Rules](https://github.com/0xkoat/backend-gerance/blob/main/src/module-access/module-levels.ts): `src/module-access/module-levels.ts`

### Tickets & Events

- [Ticket API](https://github.com/0xkoat/backend-gerance/blob/main/src/tickets/tickets.controller.ts): `src/tickets/tickets.controller.ts`
- [Ticket Management](https://github.com/0xkoat/backend-gerance/blob/main/src/tickets/tickets.service.ts): `src/tickets/tickets.service.ts`
- [Notifications](https://github.com/0xkoat/backend-gerance/blob/main/src/tickets/notifications.service.ts): `src/tickets/notifications.service.ts`
- [Live Event API](https://github.com/0xkoat/backend-gerance/blob/main/src/events/events.controller.ts): `src/events/events.controller.ts`
- [Event Delivery](https://github.com/0xkoat/backend-gerance/blob/main/src/events/events.service.ts): `src/events/events.service.ts`

### Persistence

- [Prisma Client](https://github.com/0xkoat/backend-gerance/blob/main/src/prisma/prisma.service.ts): `src/prisma/prisma.service.ts`
- **PostgreSQL**

### Other components

- **Frontend BFF**
- **Security Modules**

## Connections

- Frontend BFF → Auth API: requests auth (evidence: `README.md`)
- Auth API → Authentication: calls (evidence: `src/auth/auth.controller.ts`)
- Authentication → User Management: looks up users (evidence: `src/auth/auth.service.ts`)
- Authentication → Prisma Client: manages refresh tokens (evidence: `src/auth/auth.service.ts`)
- Authentication → JWT Strategy: builds claims (evidence: `src/auth/auth.service.ts`)
- Frontend BFF → User API: manages accounts (evidence: `README.md`)
- User API → User Management: calls (evidence: `src/users/users.controller.ts`)
- User Management → Prisma Client: reads and writes (evidence: `src/users/users.service.ts`)
- Frontend BFF → Tenant API: administers tenants (evidence: `README.md`)
- Tenant API → Tenant Management: calls (evidence: `src/tenants/tenants.controller.ts`)
- Tenant Management → Prisma Client: reads and writes (evidence: `src/tenants/tenants.service.ts`)
- Frontend BFF → Module APIs: requests module launch (evidence: `README.md`)
- Module APIs → Module Access: dispatches access (evidence: `src/module-access/modules.controller.ts`)
- Endpoint Admin API → Module Access: manages endpoints (evidence: `src/module-access/module-endpoints.controller.ts`)
- Module Access → Analyst Level Rules: checks levels (evidence: `src/module-access/module-access.service.ts`)
- Module Access → Prisma Client: checks access and records launches (evidence: `src/module-access/module-access.service.ts`)
- Module Access → Security Modules: redirects to configured product (evidence: `README.md`)
- Frontend BFF → Ticket API: raises and tracks tickets (evidence: `README.md`)
- Ticket API → Ticket Management: dispatches ticket actions (evidence: `src/tickets/tickets.controller.ts`)
- Ticket Management → Notifications: creates notifications (evidence: `src/tickets/tickets.service.ts`)
- Ticket Management → Prisma Client: stores tickets (evidence: `src/tickets/tickets.service.ts`)
- Notifications → Prisma Client: stores notifications (evidence: `src/tickets/notifications.service.ts`)
- Notifications → Event Delivery: publishes updates (evidence: `src/tickets/notifications.service.ts`)
- Frontend BFF → Live Event API: opens event stream (evidence: `README.md`)
- Live Event API → Event Delivery: streams events (evidence: `src/events/events.controller.ts`)
- Event Delivery → PostgreSQL: persists application state (evidence: `README.md`)
- Prisma Client → PostgreSQL: queries (evidence: `src/prisma/prisma.service.ts`)
