Skip to main content
Version: 1.0.0-beta

User Guide — IT Administrator

As an IT Administrator, you manage system configuration, user access, SSO integration, AI model setup, and security settings.

Your Responsibilities​

AreaTasks
User ManagementCreate users, assign roles, manage permissions
SSO / IdentityConfigure Keycloak SSO integration
AI ConfigurationSet up AI model providers (Ollama, Gemini, OpenAI)
SecurityManage encryption keys, audit logs, data retention
IntegrationsConfigure API keys, connectors, webhooks
BillingManage subscription and usage
System HealthMonitor services, logs, and performance

Key Administration Tasks​

User & Role Management​

  1. Navigate to Administration → Users
  2. Add User: Click + New User → fill in details → assign role
  3. Assign Roles: Predefined roles: Admin, CAE, Manager, Auditor, QA, Viewer, Client

Available roles and their scope:

RoleDescription
AdminFull system access including configuration
CAEAudit program leadership with approval rights
ManagerEngagement management and workpaper review
AuditorFieldwork execution, workpapers, findings
QAQuality assurance reviews
ViewerRead-only dashboard access
ClientPBC portal access only

📖 See Users & Roles for full details.

SSO Configuration (Keycloak)​

AIIA uses Keycloak for identity management:

  1. Navigate to Administration → SSO
  2. Configure your identity provider:
    • SAML 2.0 — for enterprise IdPs (Azure AD, Okta, ADFS)
    • OpenID Connect — for OAuth-based IdPs
    • LDAP — direct Active Directory synchronization
  3. Map external groups to AIIA roles
  4. Test the connection before enabling

📖 See SSO Configuration for full details.

AI Model Configuration​

  1. Navigate to Administration → AI Models
  2. Click + Add Provider
  3. Select provider type:
ProviderSetupKey Required
OllamaLocal endpoint URL❌
GeminiAPI URL + API key✅
OpenAIAPI URL + API key✅
AnthropicAPI URL + API key✅
DeepSeekAPI URL + API key✅
CustomOpenAI-compatible endpoint✅
  1. Test the connection
  2. Set as default provider
Security

API keys are encrypted at rest (AES-256-GCM). Keys are NEVER displayed in full after saving — only the last 4 characters are shown.

📖 See AI Models for full details.

Audit Log Review​

  1. Navigate to Audit Logs
  2. Filter by:
    • Date range
    • User
    • Action type (CREATE, UPDATE, DELETE, AI_ACTION, LOGIN)
    • Module
  3. Export logs for compliance reporting

📖 See Audit Logs for full details.

Data Retention​

Configure retention policies per document type via Administration → Data Retention. The system supports configurable retention periods for each document type (workpapers, evidence, reports, findings, audit logs, AI content) with customizable expiry actions (archive, delete, notify, manual review).

📖 See Data Retention for full details.

System Health Monitoring​

AIIA includes built-in monitoring tools accessible through your deployment infrastructure:

  • Grafana — service metrics and dashboards
  • Prometheus — metrics collection
  • Docker logs — docker compose logs -f [service]

Access URLs for monitoring services are configured during deployment setup.

Permissions​

As Admin, you have full access to all modules and configuration.