Documentation Roles & Responsibilities

VerityLayer - Roles & Responsibilities Guide

Overview

This document clearly defines the separation of responsibilities between Partners/Super Admins and Customer Organization Admins in the VerityLayer platform. ---

Role Definitions

Partner / Super Admin

Who: VerityLayer partner or platform administrator Access Level: Full system access, all organizations Responsibilities:
  • Platform deployment and maintenance
  • Customer onboarding
  • Tenant database provisioning
  • System monitoring
  • Billing and subscription management
  • Technical support
Access URL: https://your-veritylayer-domain.com/super_admin/

---

Customer Organization Admin

Who: Customer's designated administrator Access Level: Single organization only Responsibilities:
  • Organization settings management
  • User management within their organization
  • Module configuration
  • Data management
  • Reporting
Access URL: https://your-veritylayer-domain.com/

---

Responsibility Matrix

| Task | Partner/Super Admin | Customer Org Admin | |------|--------------------|--------------------| | Platform Setup | | | | Install VerityLayer | ✅ | ❌ | | Configure web server | ✅ | ❌ | | Configure central database | ✅ | ❌ | | Install SSL certificate | ✅ | ❌ | | Customer Onboarding | | | | Create organization | ✅ | ❌ | | Provision tenant database | ✅ | ❌ | | Set subscription plan | ✅ | ❌ | | Create org admin user | ✅ | ❌ | | Send credentials to customer | ✅ | ❌ | | Organization Management | | | | Update organization details | ✅ (via super admin) | ✅ (limited) | | Manage subscription | ✅ | ❌ (view only) | | Add/remove users | ✅ | ✅ | | Assign user roles | ✅ | ✅ | | Configure modules | ❌ | ✅ | | Data Management | | | | Migrate data to tenant DB | ✅ | ❌ | | Backup tenant database | ✅ | ❌ | | Export organization data | ✅ | ✅ | | Manage risks/vulnerabilities | ❌ | ✅ | | System Administration | | | | Monitor system health | ✅ | ❌ | | Apply platform updates | ✅ | ❌ | | Configure multi-tenant mode | ✅ | ❌ | | View audit logs | ✅ | ✅ (own org only) | | Support | | | | Technical support | ✅ | ❌ | | User support | ✅ | ✅ (own users) | ---

Partner/Super Admin Tasks

1. Platform Deployment

Location: Server command line Files:
  • database/schema.sql - Central database schema
  • database/install_org_db_connections.php - Multi-tenant tables
  • includes/config.php - Configuration
  • db_connect.php - Database connection
Commands:

``bash

Install application

cd /var/www/ unzip veritylayer-v1.0.zip

Create central database

mysql -u root -p < database/schema.sql

Install multi-tenant tables

php database/install_org_db_connections.php

Create super admin

php admin/create_super_admin.php ` Access: Command line / SSH ---

2. Customer Onboarding

Step 1: Create Organization

Location: Super Admin Dashboard URL: https://your-domain.com/super_admin/create_organization.php Or via CLI: `bash php admin/create_organization.php \ --name="Acme Corporation" \ --email="admin@acme.com" \ --plan="professional" \ --max-users=50 ` Files:
  • super_admin/create_organization.php - Web UI
  • admin/create_organization.php - CLI tool
---

Step 2: Provision Tenant Database

Location: Server command line Command: `bash php tenant-db-setup/setup_wizard.php --scenario=managed --org-id=1 ` Files:
  • tenant-db-setup/setup_wizard.php - Provisioning wizard
  • tenant-db-setup/tenant_schema.sql - Tenant schema
  • tenant-db-setup/test_connection.php - Connection testing
What it does:
  • Creates database: org_1_db
  • Creates user: org_1_user
  • Deploys schema
  • Registers connection in org_db_connections
  • Tests connection
Access: Command line / SSH

---

Step 3: Create Organization Admin

Location: Super Admin Dashboard URL: https://your-domain.com/super_admin/add_user.php Or via CLI: `bash php admin/add_user.php \ --org-id=1 \ --name="John Doe" \ --email="john@acme.com" \ --type="org_admin" \ --password="TempPassword123!" ` Files:
  • super_admin/add_user.php - Web UI
  • admin/add_user.php - CLI tool
Credentials to send customer:
  • URL: https://your-domain.com/
  • Email: john@acme.com
  • Password: TempPassword123! (temporary)
---

3. Subscription Management

Location: Super Admin Dashboard URL: https://your-domain.com/super_admin/manage_subscriptions.php Or via CLI: `bash php admin/update_subscription.php \ --org-id=1 \ --plan="enterprise" \ --status="active" \ --max-users=100 ` Files:
  • super_admin/manage_subscriptions.php - Web UI
  • admin/update_subscription.php - CLI tool
---

4. Data Migration

Location: Server command line Commands: `bash

Dry run

php admin/migrate_org_data.php --org-id=1 --dry-run

Actual migration

php admin/migrate_org_data.php --org-id=1

Verify

php admin/verify_migration.php --org-id=1 ` Files:
  • admin/migrate_org_data.php - Migration tool
  • admin/verify_migration.php - Verification tool
Access: Command line / SSH

---

5. System Monitoring

Location: Super Admin Dashboard URL: https://your-domain.com/super_admin/dashboard.php Or via CLI: `bash

Health check

php admin/health_check.php

Test all connections

php tenant-db-setup/test_connection.php --all-orgs ` Files:
  • super_admin/dashboard.php - Web UI
  • super_admin/system_settings.php - System settings
  • admin/health_check.php - CLI health check
---

6. Organization Management

Location: Super Admin Dashboard URLs:
  • View all orgs: https://your-domain.com/super_admin/dashboard.php
  • Edit org: https://your-domain.com/super_admin/edit_organization.php?org_id=1
  • View org: https://your-domain.com/super_admin/view_organization.php?org_id=1
Files:
  • super_admin/dashboard.php - Organization list
  • super_admin/edit_organization.php - Edit organization
  • super_admin/view_organization.php - View organization details
---

Customer Organization Admin Tasks

1. First Login & Password Change

Location: Main login page URL: https://your-domain.com/login.php Steps:
  • Login with credentials provided by partner
  • Change password immediately
  • Update profile information
    • Files:
    • login.php - Login page
    • UserManagement/profile.php - Profile management
    ---

    2. Organization Settings

    Location: Settings module URL:     https://your-domain.com/src/Controllers/index1.php?module=Settings/settings.php What they can configure:
    • Organization name
    • Contact information
    • Contact email/phone
    • View subscription details (read-only)
    What they CANNOT configure:
    • Subscription plan (partner only)
    • Max users (partner only)
    • Organization slug (partner only)
    • Billing address (partner only)
    Files:
    • Settings/settings.php - Organization settings
    ---

    3. User Management

    Location: User Management module URL:     https://your-domain.com/src/Controllers/index1.php?module=UserManagement/user_list.php What they can do:
    • Add users (within max_users limit)
    • Edit users
    • Deactivate users
    • Assign roles
    • Reset passwords
    Files:
    • UserManagement/user_list.php - User list
    • UserManagement/add_user.php - Add user
    • UserManagement/edit_user.php - Edit user
    • UserManagement/roles.php - Role management
    ---

    4. Module Configuration

    Location: Various modules URLs:
    • Risk settings: https://your-domain.com/src/Controllers/index1.php?module=Settings/risk_escalation_settings.php
    • SIEM settings: https://your-domain.com/src/Controllers/index1.php?module=SIEM/settings.php
    What they can configure:
    • Risk escalation thresholds
    • SIEM alert rules
    • Email notifications
    • Module-specific settings
    Files:
    • Settings/risk_escalation_settings.php - Risk settings
    • SIEM/settings.php - SIEM settings
    ---

    5. Data Management

    Location: Various modules URLs:
    • Risks: https://your-domain.com/src/Controllers/index1.php?module=Vulnerabilities/risk_register.php
    • Vulnerabilities: https://your-domain.com/src/Controllers/index1.php?module=Vulnerabilities/vulnerability_list.php
    • Assets: https://your-domain.com/src/Controllers/index1.php?module=Assets/asset_list.php
    What they can do:
    • Create/edit/delete risks
    • Manage vulnerabilities
    • Track assets
    • Generate reports
    • Export data
    Files:
    • Vulnerabilities/risk_register.php - Risk management
    • Vulnerabilities/vulnerability_list.php - Vulnerability tracking
    • Assets/asset_list.php - Asset management
    ---

    File & URL Reference

    Partner/Super Admin Files

    Web Interface:     ` super_admin/ ├── dashboard.php # Main dashboard ├── create_organization.php # Create organization ├── edit_organization.php # Edit organization ├── view_organization.php # View organization ├── manage_subscriptions.php # Subscription management ├── manage_users.php # User management ├── system_settings.php # System settings └── switch_to_org.php # Switch to org view ` Command Line Tools: ` admin/ ├── create_organization.php # Create org (CLI) ├── add_user.php # Add user (CLI) ├── update_subscription.php # Update subscription (CLI) ├── batch_provision.php # Batch provisioning ├── migrate_org_data.php # Data migration ├── verify_migration.php # Verify migration └── health_check.php # System health check tenant-db-setup/ ├── setup_wizard.php # Tenant DB provisioning ├── test_connection.php # Connection testing └── tenant_schema.sql # Tenant schema ` URLs:
    • Super Admin Dashboard: /super_admin/dashboard.php
    • Create Organization: /super_admin/create_organization.php
    • Manage Subscriptions: /super_admin/manage_subscriptions.php
    • System Settings: /super_admin/system_settings.php
    ---

    Customer Organization Admin Files

    Web Interface:     ` Settings/ ├── settings.php # Organization settings └── risk_escalation_settings.php # Risk settings UserManagement/ ├── user_list.php # User list ├── add_user.php # Add user ├── edit_user.php # Edit user └── roles.php # Role management Vulnerabilities/ ├── risk_register.php # Risk management ├── vulnerability_list.php # Vulnerability tracking └── submit_risk.php # Submit risk Assets/ ├── asset_list.php # Asset management └── add_asset.php # Add asset SIEM/ ├── dashboard.php # SIEM dashboard ├── alerts.php # Alert management └── settings.php # SIEM settings ` URLs:
    • Dashboard: /src/Controllers/index1.php?module=dashboard.php
    • Organization Settings: /src/Controllers/index1.php?module=Settings/settings.php
    • User Management: /src/Controllers/index1.php?module=UserManagement/user_list.php
    • Risk Register: /src/Controllers/index1.php?module=Vulnerabilities/risk_register.php
    ---

    Access Control Summary

    Partner/Super Admin Access

    Login URL:     https://your-domain.com/login.php After login, access:
    • Super Admin Dashboard: /super_admin/dashboard.php
    • All super admin functions
    • Can switch to any organization view
    • Can access command line tools
    Permissions:
    • Full system access
    • All organizations
    • Database access
    • Server access
    ---

    Customer Organization Admin Access

    Login URL:     https://your-domain.com/login.php After login, access:
    • Organization Dashboard: /src/Controllers/index1.php?module=dashboard.php
    • Organization settings (limited)
    • User management (own org only)
    • All modules (own org data only)
    Permissions:
    • Single organization only
    • Cannot access super admin functions
    • Cannot access other organizations
    • No server/database access
    ---

    Security Boundaries

    What Partners Can See

    ✅ All organizations ✅ All users ✅ All subscriptions ✅ System configuration ✅ Database connections ✅ Audit logs (all)

    What Customers Can See

    ✅ Own organization only ✅ Own users only ✅ Own data only ✅ Own audit logs only ❌ Other organizations ❌ System configuration ❌ Database connections ❌ Other orgs' data ---

    Documentation Locations

    For Partners

    Main Documentation:
    • docs/PARTNER_ONBOARDING.md - Complete partner guide
    • docs/TECHNICAL_ARCHITECTURE.md - Technical reference
    • docs/PARTNER_DEPLOYMENT_CHECKLIST.md - Deployment checklist
    • docs/QUICK_REFERENCE.md - Command reference
    Tool Documentation:
    • tenant-db-setup/README.md - Tenant provisioning guide
    • tenant-db-setup/CONFIGURATION_GUIDE.md - Configuration reference
    • admin/MIGRATION_GUIDE.md - Migration procedures

    For Customers

    User Guides (to be created):

    • docs/USER_GUIDE.md - End user guide
    • docs/ORG_ADMIN_GUIDE.md - Organization admin guide
    • docs/MODULE_GUIDES/ - Module-specific guides
    ---

    Summary

    Partner/Super Admin:
    • Scope: Platform-wide, all organizations
    • Access: Web UI + Command line + Database
    • Location: /super_admin/ + /admin/ + CLI tools
    • Responsibilities: Deployment, onboarding, monitoring, support
    Customer Organization Admin:
    • Scope: Single organization only
    • Access: Web UI only
    • Location: /src/Controllers/index1.php?module=...`
    • Responsibilities: Organization settings, users, data management
    Clear separation ensures:
    • Security (customers can't access other orgs)
    • Scalability (partners manage infrastructure)
    • Simplicity (customers focus on their data)
    • Support (clear responsibility boundaries)