Settings
What lives under Settings, which role sees each pane, and where the boundary between the dashboard and the API actually is.
- Version: 0.4
- Role: admin_user
Settings is the appliance's configuration surface. The page header describes it as Manage your account, how detection behaves, and who can get in. — three groups of panes in a left-hand navigation, and every pane is a separate saved configuration with its own API endpoint behind it.
/assets/screenshots/settings-overview@0.4.pngWhat lives under Settings
Account
Every signed-in account reaches these three, whatever its role.
| Pane | What it governs |
|---|---|
| Profile | Your own display name and password. This is how an account seeded with a starting password changes it. |
| Appearance & language | Theme, layout density and interface language for your account only. |
| Notifications | Which in-product notifications your account receives. |
Detection & processing
| Pane | What it governs | Documented at |
|---|---|---|
| Image Processing | OCR engine and image-analysis behaviour. | Not yet documented |
| Document Redaction | How PDF and DOCX content is redacted before it leaves the appliance. | Not yet documented |
| Data Retention | How long each class of record is kept, and whether the sweep deletes anything. | Data retention |
| ML Worker Tuning | Worker counts and batch sizes for the detection services. | Not yet documented |
| Model Routing | Which model a request is routed to. | Not yet documented |
| Prompt Compression | Input-token reduction before the provider call. | Not yet documented |
| SIEM Export | Syslog/CEF and webhook destinations for detection and audit events. | SIEM and webhook integrations |
| Certificates | The appliance's own HTTPS certificate, and the CA it trusts for outbound inspection. | Certificates |
| Help assistant | Whether the in-product assistant runs, and whether its input is inspected. | Help assistant |
Identity & access
| Pane | What it governs | Documented at |
|---|---|---|
| Active Directory / LDAP | The directory connection, the bind account and the connection test. | Active Directory and LDAP |
| Directory Sync | Sync scopes: which organisational units and groups are imported, and on what schedule. | Active Directory and LDAP |
| Identity Providers | Which authentication sources are offered on the sign-in page. | Active Directory and LDAP |
| Group Role Mappings | Which directory group grants which CID222 role and tenant group. | Active Directory and LDAP |
| Password delivery | How a password-reset link reaches the user — admin link, SMTP or EmailJS. | Password delivery |
Two system pages sit beside Settings rather than inside it: License and System updates.
Who can change what
Access to Settings is decided in two independent places, and both have to agree before a change lands.
The dashboard decides which panes are listed. Nine configuration panes are shown only to
superadmin and to viewer, its read-only twin:
- ML Worker Tuning, Model Routing, Prompt Compression, Document Redaction
- Data Retention, SIEM Export, Help assistant, Certificates
- Password delivery
The reasoning is recorded in the code rather than left to convention: retention can delete evidence, SIEM export ships detection metadata off the box, and the help-assistant pane decides whether everyone's help questions on this appliance are inspected. All three are appliance-wide, so all three sit on the same list.
An auditor account sees the Account group and nothing else. It reaches Settings for exactly
one reason — changing the password it was seeded with — and every other group would render links
that refuse to open.
The API decides whether the change is accepted. Each pane's endpoint carries its own role requirement, and it applies regardless of what the dashboard drew:
| Pane | Endpoint | Role the gateway requires |
|---|---|---|
| Certificates | /admin/certificates/status and siblings | admin_user |
| Data Retention | /admin/logs/retention | admin_user to read and to change; auditor may read |
| SIEM Export | /admin/integrations | admin_user, and an Enterprise licence |
| Help assistant | /help/settings | admin_user to change; any account may read |
| Active Directory / LDAP | /admin/ldap/config and siblings | admin_user |
| Password delivery | /admin/password-delivery | superadmin |
A viewer account is refused every mutating request globally, by the shape of the request rather
than by which endpoint it called. The refusal carries the code READ_ONLY_ROLE, and the panes
render read-only with a Read-only demo view notice.
Limits and known gaps
Per-pane access is not access control. The page registry holds one settings row whose
baseline admits every role, so the registry cannot gate a pane. The nine-pane superadmin list is a
hard-coded array in the dashboard shell, mirrored by a drift check in the gateway. It hides links;
it does not deny anything. Treat the endpoint's role requirement as the boundary.
The two halves disagree in both directions today. The dashboard hides Certificates, Data
Retention, SIEM Export and Help assistant from an admin_user, although the gateway
accepts that role on all four — an administrator has to be superadmin to reach them through the
interface, or call the API directly. In the other direction the four identity panes are listed for
normal_user, whose requests those endpoints then refuse.
Capabilities are declared, not enforced. Most settings endpoints also declare a capability —
system.certificates, retention.view and retention.manage, ldap.configure,
password_delivery.configure, integrations.manage. The help-assistant pane is the exception:
help.configure exists in the capability registry, but neither handler that writes help settings
carries the decorator, so shadow mode does not watch them at all. The capability model runs in
shadow mode: it computes
what it would have decided, records the comparison, and decides nothing. Requesting the enforcing
mode is refused and runs as shadow. Roles are what enforce.
Related tasks
- Certificates — serve a certificate your clients already trust.
- Active Directory and LDAP — sign users in with their domain accounts.
- Access control — the five roles, what each may read, and the page matrix.
Last updated on