Skip to content

Reference

Dashboard quick reference

Where to do each task in the web dashboard — a reference index, not a screen-by-screen tour.

The issuing service serves a web dashboard at /dashboard (e.g. https://keyright.delta1labs.com/dashboard, or $BASE/dashboard on a self-hosted instance). It’s a self-contained UI over the /admin/* API, identical on Keyright Cloud and on a self-hosted or air-gapped instance. This page is an index — where each task lives. The task guides linked below explain how, and the HTTP API reference has the endpoint behind every screen.

Signing in

The sign-in page offers only the methods enabled on the instance: email + password + authenticator code (the self-hosted default; the first sign-in enrols two-factor), Google / GitHub or hosted accounts when configured, single sign-on (OIDC) on plans that include it, and Advanced → access token for operators — paste a team or session token, or, to bootstrap the first owner on a fresh self-hosted instance, your KEYRIGHT_ADMIN_TOKEN. A successful sign-in mints a short-lived session token that authorizes the rest of the dashboard. Press Ctrl+K (⌘K) anywhere to search or jump to any page.

Experience level: Basic, Intermediate, Advanced

The dashboard opens in a calm Basic view and reveals more in place as you switch level — nothing is moved or removed, and features you already use (coverage, credits, resellers) show up on their own. Switch from the navigation footer, the account menu, or Settings → Workspace → Experience level; the choice is remembered per browser.

ViewReveals
Basic (default)Home, Licenses, Products (editions), Settings — enough to create a product, issue a key and see who activated.
IntermediateCustomers, Releases & coverage, Developers, Activity; exports, CSV import, bulk actions, offline license files and transfers.
AdvancedUsage & credits, Resellers; the technical coverage ledger, event webhooks and metering, the CLI, and Data / Instance / Branding settings.

Task → where to do it

Everything below is reached from the left sidebar on the Home screen:

The Keyright dashboard Home with the left sidebar navigation — Home, Licenses, Customers, Products, Releases & coverage, Usage & credits, Resellers, Developers, Activity and Settings — a Self-hosted badge beside the workspace name, the Ctrl+K search box in the header, four summary tiles (Active licenses, Active devices, Expiring in 30 days, Revoked), a 'Finish setting up' checklist, and a recent-activity feed.
The Home screen and its left sidebar — the starting point for every task in the table below (press Ctrl+K / ⌘K to jump anywhere).
TaskIn the dashboardGuide
Issue a licenseLicenses → Issue licenseActivation & seats
Enable a free trialProducts → (product) → TrialsFree trials
Gate a feature / edit entitlementsProducts → (product) → EditionsFeature gating
Set a coverage policy / sell upgradesReleases & coverage → Coverage policyRelease coverage
Meter usage & creditsUsage & credits (and Products → Pricing)Credits & metered usage
Revoke or renew a licenseLicenses (row menu, or the license page)Revoke, renew & expiry
Hand out an offline / air-gapped license fileLicense page → License fileOffline & air-gapped
Auto-issue keys from your storeDevelopers → WebhooksStore fulfillment
Get your signing key / public keyDevelopers → Keys (or Products → Signing key)Getting started, step 2
Manage team & rolesSettings → TeamAPI reference → Team

Team and the other account-wide settings live under Settings, each role scoped to what it can do:

The Settings → Team screen, with a settings sub-navigation down the left (Workspace, Team, Sign-in & security, Email & alerts, Plan & billing, Data, Instance, Branding). The Team panel — 'Everyone who can sign in to this dashboard' — has an Invite member button and an empty-state prompt noting you're signing in with the admin token. A 'What each role can do' panel describes the Owner, Admin, Support, Billing and Viewer roles, and a 'How members sign in' panel notes that two-factor is required for password sign-in.
Settings → Team: invite teammates and assign roles — Owner, Admin, Support, Billing or Viewer.

Customer portal and operator console

The customer portal at /portal (magic-link sign-in) lets your customers see each license’s status and coverage sentence, copy the key, free a device seat, and download their offline license file. The operator console at /platform (multi-tenant operators only) shares the same design in a dense layout for managing tenants, plans and signing keys — see Self-hosting.