Reference
Console pages reference
Every page of the YuviRed console in menu order: what it is for, its main controls, and who can see it.
This reference covers YuviRed 1.0 (app 1.0.0, installer 1.0.322.1608, endpoint agent 1.8.2, browser extension 0.5.5) for Windows. The console is one web page served by the YuviRed server, normally at https://<server>:8443/. Names below are exactly as they appear on screen.
How to read this page
- Who can see it has two parts. The left menu hides some items by role (the console decides from the account's role: Admin, Analyst or View Only). Separately, the server checks a permission on each request the page makes. The pages below say which permission the page's data needs. A page can open for a role and still show an error or an empty list if the server refuses the data. See roles-and-permissions.md for the permission table.
- "Admin" in this page means an account whose role is Admin (the first account created at setup, and any account you create with the Admin role). "Analyst" and "View Only" are the other two roles in the console.
- AIDR (AI Detection and Response) is the first product area. AMS (Agent Monitoring System) is the second. A switch at the top of the left menu (AIDR and AMS) changes which menu is shown. Both share the same top bar, sign-in and license.
- The guide chapters named in "Guide" are in
docs/customer/admin-guide/. - Present but inactive on YuviRed Lite. The console is one program for every edition, so a few controls that belong to the Docker appliance edition appear on a Lite server and change nothing there. They are named in the page that shows them: the Deployment Tokens panel on Agent Deployment, and the settings Automatic Agent Updates, Remote Browser Extension Wiring, Extension distribution mode, Chrome Web Store extension ID and Allow extension wiring over http agents on Configuration (see settings.md, section 9). The panel Deploy Endpoint Agent is hidden on Lite outright.
The top bar and global controls
These appear on every page after sign-in.
| Control | What it does |
|---|---|
| Page title | Shows the current page's title (for example "Alert Management"). The browser tab title mirrors it, prefixed "YuviRed". |
| Role badge | Shows Admin, Analyst or View Only. |
| Clock | The current time. |
| Filter | Opens a filter bar for the current table: a search box ("Search the current page..."), a status drop-down ("All Status"), a risk drop-down ("All Risk / Severity": Critical, High, Medium, Low) and Clear. Hidden on Alerts, which has its own controls. |
| Export | Exports the current page to CSV. |
| Moon icon | Switches between light and dark theme. The choice is kept in the browser. |
| Refresh | Reloads the current page's data now. |
| License banner | Appears when the server is inside its 7-day activation window ("This YuviRed server is not activated. You have N days left to activate it. After that, the console is unavailable until it is activated.", with Activate now; the count reads "1 day" or "less than 1 day" at the end), or 30, 14 and 7 days before a paid license ends (with License). See statuses-and-errors.md. |
| Update banner | Appears when the daily license check-in names a newer YuviRed version: "YuviRed <version> is available. This server runs <version>. Nothing is installed automatically." It has Download (when a link was given) and Dismiss. Dismissal is kept per browser. |
| Critical alert banner | Shows the most recent open critical alert, with Investigate (opens Alerts) and a dismiss cross. |
| Live status (bottom of left menu) | Connecting live updates..., Monitoring... (live), Reconnecting live updates..., or Live updates paused; refreshing every 30s. |
| Account menu (click your name, bottom left) | My Account, Change Password, Authentication / MFA, Recovery Codes, Active Sessions (greyed out, marked "soon": this build does not track individual sessions), Sign Out. |
| Collapse | Collapses the left menu to icons. The choice is kept in the browser. |
Guide: administration.md.
First-run setup and sign-in screens
Shown before the console, not in the menu.
| Screen | Purpose and controls |
|---|---|
| Welcome to YuviRed / Create your administrator account | Shown once, on the server itself, while no administrator exists. Fields: Full Name, Email, Password, Confirm Password; a required box "I accept the YuviRed End User License Agreement (version 1.0) and I have read the Monitoring and Data Notice"; button Create Account. The account becomes the owner (the super_admin role). |
| Sign in | Email, Password, Sign In, and Sign in with SSO when single sign-on is set up. |
| Verification code | Verification code (6-digit authenticator code or a recovery code), Verify, Back. The step lasts 2 minutes. |
| Forced MFA enrolment | QR code and Secret, Code from your app, Enable & Sign In. Then recovery codes with Download .txt, Copy and Continue. Shown for a role that must use MFA (multifactor authentication). |
| Session Expired | Blocking dialog with Log In Again. |
| YuviRed license | Activation screen: Installation ID (Copy), Activation code (Activate), License file (Upload license file, Download license request), Sign out. Opens by itself when the server is locked. |
Guide: setup.md and licensing.md.
AIDR menu
Monitor section
Dashboard (page title "AI Threat Intelligence")
- Purpose: the first page after sign-in: a summary of endpoints, AI tools, open alerts and AI network activity.
- Main controls: five cards (Endpoints, AI Tools, Shadow AI, Open Alerts, Data Egress) that open the related page; panels Risk Distribution, Active Policies (Manage), AI Traffic, Top AI Destinations (View all), Recent Alerts, Active Endpoints and a Detected AI Tools table (Tool, Vendor, Category, Status, Endpoints, Severity, Last Seen).
- Who can see it: every signed-in role. The data route needs only a signed-in account.
- Guide: aidr.md.
AI Tools (page title "AI Tool Inventory")
- Purpose: every AI tool seen on the monitored computers, each with its effective classification. The catalog of known tools and their defaults is managed from here.
- Main controls: the inventory table; Manage Catalog (Admin only); a classification can be changed by roles that hold the
policies.writepermission (Analyst and Admin). - Who can see it: every signed-in role (list needs only a signed-in account). Manage Catalog is Admin only.
- Guide: aidr.md.
Alerts (page title "Alert Management")
- Purpose: findings from the policy engine and the prompt guard, with status, severity and assignment. Click an alert to investigate it.
- Main controls: sort (Recent activity, Risk first); filters for severity, status (open, acknowledged, investigating, resolved, false_positive, suppressed), classification, category, tool, time (Last 24 hours, Last 7 days, Last 30 days), endpoint and user; Search alerts.... The menu item shows a badge with the open count.
- Who can see it: shown to every role in the menu; the data needs
alerts.read(Admin, Analyst, View Only; not the Developer role). Changing a status or adding a note needsalerts.write(Analyst and Admin). - Guide: alerts-and-integrations.md.
Prompt Monitoring
- Purpose: prompt-level events from the browser extension (the sensitive-data guard): what was observed, warned about or blocked, with a redacted excerpt. Also shows protection status per browser and the active Prompt Protection policy.
- Main controls: an Alerts link, filters, Export CSV, the table "Suspicious content events" (ID, When, Type, Severity, Outcome, Category, Rule, Conf., Endpoint / User, Provider, Excerpt (redacted)); a browser protection card (see the Protection status list in statuses-and-errors.md).
- Who can see it: the data needs
alerts.read. Export CSV and original prompt samples needalerts.writeanddlp.view_raw_content(Admin roles only for the latter). - Guide: sensitive-data.md and extensions.md.
Network (page title "AI Egress & Destinations")
- Purpose: AI domains your computers resolve and reach, with volume. Gives you a list to hand to a firewall, proxy or DNS device. YuviRed does not block network traffic itself.
- Main controls: panel AI Destinations with Refresh and an export menu (the denylist for your device, discovery only); panel Blocklist Feed URL with Generate, Rotate and Revoke for a token-protected URL your device can poll.
- Who can see it: summary needs only a signed-in account. Exporting the denylist needs
blocklist.manage(Analyst and Admin). Generating, rotating or revoking the feed token needsconfig.write(Admin). - Guide: aidr.md.
Endpoints (page title "Endpoint Monitor")
- Purpose: every enrolled computer: identity, last check-in, liveness, risk and agent version. Also lists browser-extension lifecycle changes.
- Main controls: table "Enrolled Endpoints" with filters (search, OS, status Online/Stale/Offline, risk, agent version) and sort; per-row detail, refresh-now and Remove endpoint (with a confirmation that states what is deleted); panel Extension Changes with a change-type filter (installed, removed, enabled, disabled, version change, permission change, manifest change).
- Who can see it: the list, endpoint detail and raw telemetry need only a signed-in account (see roles-and-permissions.md). Refresh-now and log collection need
endpoints.operate. Removing, decommissioning and reactivating needendpoints.manage(Admin). - Guide: endpoints.md.
AI Map (page title "AI Map")
- Purpose: a map of who is using AI, which applications, and which providers are involved.
- Main controls: Activity and Detections mode buttons; search ("Search actors, apps, providers, domains..."); time range (Last 5 minutes to All time, Custom range); Refresh; paging arrows. A "Save view" button is present but not implemented (it shows "Saved views are not implemented yet").
- Who can see it: every signed-in role (needs only a signed-in account).
- Guide: aidr.md.
User Behavior (page title "User Behavior Analytics")
- Purpose: per-user AI usage and risk, attributed from process telemetry.
- Main controls: Refresh; panels Highest-Risk Users, Behavior Patterns, Top AI Users by Activity.
- Who can see it: every signed-in role (needs only a signed-in account).
- Guide: aidr.md.
Investigations
- Purpose: incidents: group related alerts and track them from triage to resolution.
- Main controls: New Incident; list "Active Incidents"; a detail pane with a status selector (open, investigating, contained, resolved).
- Who can see it: reading needs only a signed-in account. Creating, changing and deleting incidents needs
alerts.write(Analyst and Admin). - Guide: alerts-and-integrations.md.
Artifact Analysis
- Purpose: look up or submit one file (an "artifact") to an outside analysis provider. The feature is off by default (
artifact.enabledis off), and with the default policy nothing leaves the server. - Main controls: panel Analyze an Artifact (Browse, Analyze Artifact, Choose another file); panel Recent Analyses. Settings live under Configuration, Artifact Analysis.
- Who can see it: the menu item shows only to accounts holding
artifact.read(Admin, Analyst, View Only). Starting an analysis needsartifact.analyze(Analyst and Admin). Deleting history and testing providers needartifact.manage(Admin). - Guide: aidr.md.
Govern section
Policies (page title "Security Policies")
- Purpose: detection rules that decide what becomes an alert.
- Main controls: the rule list with an enable/disable toggle; New Policy (Admin only).
- Who can see it: every signed-in role can list. Creating, editing and deleting need
policies.write(Analyst and Admin); the New Policy button is shown to Admin. - Guide: aidr.md.
Enforcement (page title "Enforcement: Response Actions")
- Purpose: controlled response actions that follow a fixed life cycle: request, dry-run, approve, run, roll back. An Analyst may request; only an Admin may approve, run or roll back.
- Main controls: New Action; the action list with a status for each action (see statuses-and-errors.md).
- Who can see it: hidden from View Only. Requesting and viewing need
response.read(Analyst and Admin); approve, reject, run, recall, roll back, disable, archive and delete needresponse.enforce(Admin only). - Guide: alerts-and-integrations.md.
Blocklist (page title "Blocklist Manager")
- Purpose: domains, addresses and processes you want treated as blocked in detection.
- Main controls: Add Entry; a remove control per entry.
- Who can see it: Admin only in the menu. Changes need
blocklist.manage(Analyst and Admin at the server). - Guide: aidr.md.
Reports
- Purpose: download an Executive Summary (about 2 to 4 pages, PDF) or an Auditor's Report (PDF plus a ZIP package), and see a live overview. It is also reachable from the AMS menu under Related.
- Main controls: tabs Reports and Live overview; the report builder; Report history with Refresh and a Show reports by everyone box (Admin only); on Live overview: Refresh, CSV, HTML, Print / PDF.
- Who can see it: needs
reports.read(all five built-in roles). Seeing, downloading and deleting reports made by other people needsreports.manage(Admin). - Guide: reports.md.
Deployment Campaigns
- Purpose: tracks the roll-out of agents from package delivery to
fully_ready. It tracks; it does not push software. On YuviRed Lite every Add Computer download appears here as a campaign named "Add Computer" with the date and time (UTC); Revoke stops that download, and computers it already added keep reporting. - Main controls: status filter (All statuses, Draft, Active, Paused, Completed, Revoked, Expired), Refresh, New Campaign (Admin only), lifecycle actions on a campaign.
- Who can see it:
deployment.read(Admin, Analyst, View Only). Creating or changing a campaign needsdeployment.manage(Admin). - Guide: endpoints.md.
Deploy section (Admin only)
Agent Deployment
- Purpose: put the endpoint agent on more computers.
- Main controls on YuviRed Lite: panel Add Computer ("Download an installer for another Windows computer on this network"), which shows the server address, Computers: N of 10 and AI agents: N of 5, the server certificate's SHA-256 fingerprint to compare, the field Computers this download may enroll and the button Download installer (the download is valid for 24 hours); panel Deployment Tokens (New); Agent Monitoring Scope; Recent Check-ins; Endpoint Credential Rotation with Refresh, Select all shown, Clear and Rotation Operations. The panel Deploy Endpoint Agent (script commands, Test Connection, Interactive, Unattended (RMM / Intune / SCCM)) is hidden on Lite, because those commands do not produce a working agent on Lite.
- Present but inactive on Lite: the Deployment Tokens panel still shows. A token made with New is meant for the install commands of the hidden panel, so on Lite nothing in the console uses it; each Add Computer download carries its own short-lived enrollment credential instead (it appears under Deployment Campaigns as "Add Computer" with the date and time).
- Who can see it: Admin only in the menu. Add Computer, tokens and rotation need
endpoints.manage. The button This server was moved or restored (shown only after a hardware change) needslicense.manage, so only the first account can use it. - Guide: endpoints.md.
Adoption Requests (page title "Endpoint Adoption Requests")
- Purpose: review computers asking to take over an existing endpoint's identity (for example after a reinstall). Approve or reject each one.
- Main controls: Refresh, and Approve or Reject per request. Request statuses: pending, approved, rejected, expired.
- Who can see it: Admin only. Needs
endpoints.manage. - Guide: endpoints.md.
Admin section (Admin only)
Configuration (page title "Platform Configuration")
- Purpose: every setting an administrator may change, plus the license panel. Described in full in settings.md.
- Main controls: panel License (subtitle "Plan, limits and license for this server"; buttons Activate or import license, Download license request, Reload; the plan badge, Licensed to, Plan, Expires, Serial, Installation ID, Last check-in, and the counters Computers used and AI agents used); panel Platform Configuration (Discard Changes, Save Changes, a chip per section, Expand all, Collapse all, Advanced, Diagnostics); Notifications: Test Send; Classifications (Add Classification, Reload); Telemetry Retention (Reload, Run now (dry run), Run now); Daily Digest. If the panel cannot load every detail it says "Could not load all license details. Choose Reload."
- Present but inactive on Lite: in the System section, Automatic Agent Updates and Remote Browser Extension Wiring (and the advanced extension distribution rows) can be switched but change nothing on a Lite server. See settings.md, section 9.
- Who can see it: Admin only in the menu. Reading settings needs
config.read; saving needsconfig.write; the license actions needlicense.manage(only thesuper_adminrole, which is the first account). - Guide: administration.md and licensing.md.
Legal (page title "Legal Documents")
- Purpose: the documents that ship with this product (EULA, privacy notice, notice, data notice, third-party notices), the acceptance record, and a preview of the employee notice.
- Main controls: panels Legal documents (one row per document, with version and effective date), Acceptance records, Employee notice preview (your organization name and privacy contact are filled in from Configuration), Copy link.
- Who can see it: Admin only in the menu. The acceptance record route needs
config.read. - Guide: setup.md.
Help (page title "Help and Support")
- Purpose: links to the documentation and the support contact, with the two facts support asks for.
- Main controls: one panel, Help ("Documentation and support"), with seven items in this order: Documentation (offline copy on this server) (opens the copy served by this server at
/static/docs/, no sign-in needed), Online documentation (https://yuvired.com/docs), Quick start, Troubleshooting, Collect diagnostics for support (the offline pages for each), Legal documents (opens the Legal page), and Contact support: support@yuvired.com (include your installation id and version), followed by the line Installation id: ... Version: ... read from this server (it says "unavailable" when the server does not answer; the links still work). - Who can see it: Admin only in the menu. The installation id and version come from the license status route, which needs only a signed-in account.
- Guide: troubleshooting/index.md.
Team / Users (page title "Team & User Management")
- Purpose: create users and set their role, department and active state; reset passwords; turn off another user's MFA; sign a user out everywhere.
- Main controls: panel Team Management with Add User (Full Name, Email, Password, Role: Analyst, View Only, Admin, Department; Create User), a table (Name, Email, Role, Department, Last Login, Status, MFA) with edit, reset-password, turn-off-MFA and delete icons. You cannot change your own role or deactivate your own account.
- Who can see it: Admin only. Needs
users.readandusers.manage. - Guide: administration.md.
Debug / Reset
- Purpose: live counts, the last 5 telemetry payloads, and a Data Reset that clears test data.
- Main controls: panel Platform Debug Status ("Admin only, live counts and last telemetry") with Refresh and Last 5 Telemetry Payloads Received; panel Data Reset ("Clear test data. Users and tokens are preserved") with the text "Select what to clear, then click Reset. This cannot be undone.", tick boxes Telemetry records, Alerts, Endpoints (tick Telemetry records and Alerts too), AI Tool catalogue, and Reset Selected. Treat it as destructive.
- Who can see it: Admin only. Needs
debug.access. - Guide: administration.md.
System Logs
- Purpose: diagnose problems.
- Main controls: panel Feature Status ("Admin only, what's working right now") with Refresh; panel Something Went Wrong? (what to send your YuviRed contact; shown on Lite only); Endpoint Agent Logs with an endpoint drop-down, Collect logs and Refresh (logs are collected only when you ask; bundles are kept 7 days, at most 3 per endpoint; needs agent 1.4.9 or later); Live Logs with a level filter, Autoscroll, Pause, Clear.
- Who can see it: Admin only. Needs
debug.access; collecting agent logs needsendpoints.operate. - Guide: administration.md.
AMS menu
AMS pages are reached with the AMS switch. Each page opens with a one-line purpose. All AMS read pages need ams.read (Admin, Analyst, View Only). Acts on a live AI agent need admin-tier permissions: ams.manage, ams.message, ams.approve, ams.policy, ams.stop, ams.bulk. Guide for the whole group: ams.md.
| Menu item | One-line purpose (as shown) | Main controls and notes |
|---|---|---|
| Overview | "What is happening and what needs your attention" | Fleet-level summary of AI agents. |
| Agents | "Find an agent and inspect or control it" | Agents roster button, Search agents..., a roster filter (attention, unowned, paused, or an approval state), an All Agents card and a per-agent card with tabs. Badge (amber) counts agents awaiting a governance decision. Approval states: Unreviewed, Under review, Approved, Restricted, Unauthorized, Referred to AIDR. |
| Governance | "The rules agents must follow, and whether they are active" | The control policy and its state. |
| Alerts & Actions | "Findings, interventions and their verified results" | Badge (amber) counts pending approvals. |
| Coverage & Connections | "What AMS can see and control, and how to close gaps" | Coverage gaps and connectors. |
| Reports (under Related) | Opens the same Reports area as AIDR | See Reports above. |
Pages and features that do not exist
- Active Sessions in the account menu is present but disabled: this build does not track individual sessions.
- Save view on the AI Map is not implemented.
- There is no Decommission control in the Agent Deployment page; Remove endpoint on Endpoints is what frees a computer seat (and it deletes that computer's history).
- There is no Backup page. Lite ships no backup command.
- The console cannot change the log level or any setting marked server-only in settings.md.
- There is no console setting for the session length (8 hours) or for the sign-in lockout rules; see roles-and-permissions.md.
- Nothing in this release installs the browser extension into Chrome or Edge by itself. The Prompt Monitoring page's setup steps on Lite describe the manual route (Load unpacked from
C:\Program Files\YuviRed Agent\extension). Automatic installation from the browser store is planned for a later update.