1. guides
prorm
  • prorm documentation
  • Known test gaps
  • Architecture
  • Core concepts
  • Database types & coverage
  • Getting started
  • Going further
  • compliance
    • Compliance
    • The security toolkit: `prorm audit`
    • Checklists by regulation
    • Declaring personal data
    • Evidence bundles
    • Evidence
    • Frameworks: `@Security`
    • Jurisdictions
    • Platform policies
    • Protecting data
    • The regulation dataset
    • Residency and cross-border transfers
    • Retention & integrity
    • Status
    • Subject rights
  • decorators
    • prorm with decorators
    • Models with decorators
    • Querying a decorated model
    • Relations with decorators
  • diagrams
    • Diagram generators
    • Chen diagram
    • Class diagram
    • Dependency diagram
    • ER diagram
    • Flow diagram
    • From your models to a diagram
    • Gantt diagram
    • Index diagram
    • Migration diagram
    • Model diagram
    • Package diagram
    • Crow’s-foot diagram
    • Schema documentation
    • Sequence diagram
    • State diagram
    • Tree diagram
  • dialects
    • SQL dialects
    • AlloyDB Dialect
    • AlloyDB Omni Dialect
    • Amazon Athena Dialect
    • Aurora DSQL Dialect
    • Amazon Aurora MySQL Dialect
    • Amazon Aurora PostgreSQL Dialect
    • Azure Database for MySQL Dialect
    • Azure Database for PostgreSQL Dialect
    • Azure SQL Database Dialect
    • Azure SQL Managed Instance Dialect
    • Google BigQuery Dialect
    • Citus Dialect
    • ClickHouse dialect
    • Cloud Authentication (`cloud-auth`)
    • Cloud SQL for SQL Server Dialect
    • Cloud SQL for MySQL Dialect
    • Cloud SQL for PostgreSQL Dialect
    • CockroachDB Dialect
    • Azure Cosmos DB for PostgreSQL Dialect
    • CrateDB Dialect
    • Cloudflare D1 Dialect
    • Databricks dialect
    • IBM Db2 Dialect
    • Dolt Dialect
    • Apache Doris Dialect
    • Druid Dialect
    • DuckDB Dialect
    • Exasol dialect
    • Microsoft Fabric Data Warehouse Dialect
    • Firebird Dialect
    • Greenplum Dialect
    • SAP HANA Dialect
    • MySQL HeatWave Dialect
    • Azure Data Explorer (Kusto) Dialect — T-SQL
    • MariaDB Dialect
    • Materialize Dialect
    • MonetDB Dialect
    • MotherDuck Dialect
    • Microsoft SQL Server Dialect
    • MySQL Dialect
    • Neon Dialect
    • OceanBase Dialect
    • openGauss Dialect
    • Oracle Dialect
    • Oracle Autonomous Database Dialect
    • ParadeDB Dialect
    • PolarDB Dialect
    • PostgreSQL Dialect
    • Presto Dialect
    • QuestDB Dialect
    • Aurora RDS Data API Dialect (`rdsdata`)
    • Amazon RDS for Db2 Dialect
    • Amazon RDS for MariaDB Dialect
    • Amazon RDS for SQL Server Dialect
    • Amazon RDS for MySQL Dialect
    • Amazon RDS for Oracle Dialect
    • Amazon RDS for PostgreSQL Dialect
    • Amazon Redshift
    • Amazon Redshift Data API Dialect
    • RisingWave Dialect
    • rqlite Dialect
    • SingleStore Dialect
    • Snowflake Dialect
    • Google Cloud Spanner Dialect
    • Spanner (PostgreSQL interface) Dialect
    • SQLite Dialect
    • StarRocks Dialect
    • Supabase Dialect
    • Azure Synapse Analytics (dedicated SQL pool)
    • Teradata Dialect
    • TiDB Dialect
    • TimescaleDB Dialect
    • Trino Dialect
    • Turso / libSQL Dialect
    • Vertica dialect
    • Vitess Dialect
    • Yellowbrick Dialect
    • YugabyteDB Dialect
  • guides
    • Access rules and behaviour profiles
    • ArangoDB (AQL)
    • Associations
    • Audit levels and escalation
    • Audit logging
    • In the browser
    • Bulk operations
    • Caching
    • Capabilities, tiers and team roles
    • CLI
    • Cloudflare
    • Compliance & data protection
    • Connection Pooling & Performance
    • Security in the console
    • Couchbase: structured N1QL queries
    • Data types
    • Decorators
    • Eager loading
    • Enums and constants
    • Error handling & error types
    • Extensions
    • External fields
    • Foreign data wrappers
    • Graph databases
    • Hooks & lifecycle events
    • Indexes & constraints
    • InfluxDB: structured Flux pipelines
    • klock-errors
    • klock — the `.klock` file
    • Local databases (`prorm db up`)
    • Structured log search — Splunk, Graylog, Papertrail, Sumo Logic
    • Logging
    • Grafana Loki: structured LogQL queries
    • MCP server
    • Migrate — the data transfer subsystem
    • Migrations & Schema Sync
    • Models from an existing database
    • Defining models
    • Multiple databases
    • OrientDB, Neptune and TigerGraph
    • Passwords
    • Importing a Prisma schema
    • Structured PromQL and MetricsQL
    • Query firewall
    • QueryInterface
    • Query operators reference
    • Query optimization
    • Composing find options with `pipe()` and `Q`
    • Query safety: the fail-closed WHERE guard
    • Querying
    • Raw Queries & Query Building
    • Read replicas
    • Schema diffing & migration generation
    • Views, triggers & other schema objects
    • Scopes & default scopes
    • Seeders
    • SPARQL / RDF triplestores
    • SQL constants
    • SQL features
    • SQL function builders
    • SQLite advanced features
    • StoreKey — a prod-orm database as the storage
    • Streaming results
    • Terraform
    • Transactions & Isolation Levels
    • Type mapping: legacy and modern
    • TypeScript types
    • Database users, roles & privileges
    • Validation & constraints
    • Virtual & Computed Fields
    • Writing docs
  • javascript
    • prorm in JavaScript
    • Models in JavaScript
    • Querying in JavaScript
    • Relations in JavaScript
  • runbooks
    • Operational runbooks
    • Connection failures
    • Credential rotation
    • Failover
    • Incident checklist
    • Deploying klock v2
    • Migration rollback
  • running-databases
    • Running databases in Docker
    • Running prorm under Bun in Docker
    • Running Cassandra in Docker with prorm
    • Running ClickHouse in Docker with prorm
    • Running CockroachDB in Docker with prorm
    • Running prorm under Deno in Docker
    • Running Elasticsearch in Docker with prorm
    • Running MariaDB in Docker with prorm
    • Running MongoDB in Docker with prorm
  • prorm control plane
    • Introduction
    • Authentication
    • Errors
    • Getting started
      • Service
        • Is it up
        • This description
    • Account
      • Sign-up and verification
        • Create an account
        • Exchange credentials for a token
        • Verify with the emailed code
        • Verify by clicking the emailed link
        • Name the parent or guardian
        • What a consent link is about
        • Give consent for a child's account
        • Ask the parent or guardian again
        • Send a new code and link
      • Family
        • Everyone this account is responsible for
        • One child, in detail
        • Turn a limit on or off
      • Profile
        • Who am I
        • Change the account
        • Every address on the account
        • Add an address
        • Confirm an address with the code mailed to it
        • Mail a fresh code to an unconfirmed address
        • Make an address primary
        • Remove an address
        • What this caller may do
    • Security
      • Sessions
        • Everywhere this account is signed in
        • Sign out everywhere else
        • Sign one out
        • A token for the CLI on a named machine
        • A token for the customer console, from the staff one
        • Park a sign-in for the CLI to collect
        • The CLI collecting its sign-in
        • The team's members' live sessions
        • Sign a member's session out
        • Sign an account out everywhere
        • Everywhere the account is signed in
        • Sign an account's session out
      • Single sign-on
        • Begin a single sign-on
        • The provider's return
        • Link the signed-in account to a team's provider
        • Which team an address signs in to
        • The team's single sign-on, as a member sees it
        • Set the team's OpenID Connect provider up, or change it
        • Remove the provider
        • The team's domain claims and the DNS record each needs
        • Prove a claimed domain
      • MFA and passwords
        • Start enrolling a second factor
        • Prove the app has it
        • Remove the second factor
        • Ask for a reset link
        • Set a new password with the emailed token
      • Klock
        • Open a device-bound klock session
        • Check in, for the next grant
        • Step up the session asking
        • Rotate the device key
        • Freeze a session
        • Unfreeze a session
        • A guest grant
        • The revocation feed
        • The published keyset
        • What this control plane supports
      • Devices
        • Your devices, or a team's
        • Approve a new device's pairing code
        • One device
        • Rename a device
        • Revoke a device
        • Suspend a device
        • Reinstate a suspended device
        • Wipe a device
        • Ask a device to rotate its key
        • The team's members' devices
        • Revoke a member's device
        • An account's devices
        • Revoke an account's device
        • Wipe an account's device
        • The device fleet
      • Access rules and behaviour
        • The access rules that bear on you
        • Add an access rule
        • This request, as the rules see it
        • One access rule
        • Remove an access rule
        • The behaviour profiles that bear on you
        • Add or change a behaviour profile
        • The profile presets
        • Your behaviour findings
        • Acknowledge a finding
        • One behaviour profile
        • Remove a behaviour profile
        • The team's access rules
        • Add a team access rule
        • Remove a team access rule
        • The team's behaviour profiles
        • Add or change a team behaviour profile
        • Remove a team behaviour profile
        • What the team's profiles caught
        • Acknowledge a team finding
      • Recovery and lockdown
        • Ask for a recovery link
        • Recover access with the emailed code
        • Is the account locked down
        • Lock the account down
        • Release a lockdown
        • Lock a member down
        • Release a member's lockdown
      • MCP tokens
        • Make a delegated token for one MCP client
        • The account's delegated tokens
        • Revoke a delegated token
        • What a delegated token may do now
        • Run one MCP tool with a delegated token
        • Run a device-signed MCP tool call relayed by the MCP Worker
      • Kerberos
        • Give the team its own Kerberos realm
        • The team's realm
        • Remove the team's realm
    • Logging and monitoring
      • Audit log
        • What has been done to the account
        • What has happened to this account
        • The account's audit trail
      • Operations
        • Everything that has been asked of this database
        • One, with its steps
        • Stop it
        • Put a failed one back in the queue
        • Every operation, across all accounts
      • Metrics and events
        • Every measurement, for a graph
        • Who did what to it
    • Billing
      • Plans and pricing
        • What the plans allow
        • The rate card
        • What one database would cost
        • What this account is paying for, itemised
      • Subscriptions and invoices
        • What this month's invoice will say
        • What this account is on
        • What it has been charged
        • Start a Stripe Checkout session
        • Open the customer portal
        • Stripe's events
        • Buy more connection pools
      • Team billing
        • The team's billing account
        • What the team has been charged
        • What this month's invoice will say
        • The team's cards
        • Add a card, through a Stripe-hosted setup session
        • Make a card the team's default
        • Remove a card
        • Start the team paying
        • Open the Stripe portal on the team's customer
        • Change the team's plan
        • Who receives the team's bills
        • How the team pays for transfers
    • Support
      • Support chat
        • My conversations
        • Start a conversation
        • Every support conversation, open first
        • A ticket for the socket
        • One conversation, with who is in it and who is connected
        • Rename a group; open or close a support conversation
        • The lines, oldest first
        • Say something
        • Add somebody
        • Mark read
    • Administration
      • Users
        • Every account
        • One account, with everything hanging off it
        • Grant or revoke admin
        • Verify an account by hand
        • Lock or unlock sign-in
        • Allow or hold provisioning
        • Send the verification mail again
        • Set the plan by hand
      • Platform
        • Every database and store, across all accounts
        • The counts worth putting on a dashboard
      • Staff and permissions
        • What kind of admin the caller is, and which scopes they hold
        • The admin presets
        • Every admin, and the scopes each resolves to
        • Make an account an admin of a kind
        • Change an admin's kind, or a custom admin's scopes
        • Revoke admin
      • Team administration
        • Every team, with its owner and size
        • One team in full — members with their accounts, and projects
        • Hand the team to another member
        • Put an account in the team, active at once
        • Change a member's role
        • Remove a member
      • Assumed identities
        • Assume an identity — act as a customer account
        • The identities the caller holds open
        • End an assumed identity
      • Support inbox
        • The platform's addresses
        • Add a platform address
        • One address, with its counts
        • Change an address's label, routing, or whether it accepts mail
        • Remove an address that holds no mail
        • Make, adopt or repair the address's routing rule
        • Every admin's personal address, made where missing
        • File a raw message, as if it had arrived
        • The inbox
        • One message, whole
        • Mark a message
        • Hand a message to an admin, or take it back
        • Leave an internal note
        • Reply, from the address the message came to
        • What is waiting
    • Databases
      • Databases
        • Data stores
          • Every data store on the account
          • Provision a data store
          • Change a data store that is already running
          • One data store
          • Deprovision it
          • Report what it is using
          • How to reach a data store
        • Connections and credentials
          • The api keys on a database
          • Issue a key
          • Revoke a key
          • The engine users we created
          • Create a user inside the database
          • Give a user a new password
          • Drop a user
          • How the database is reached
          • Set how it is reached
          • Revoke every api key on it
          • How to connect to it
          • The ssh keys that open its bastion
          • Add a key, or have one made
          • The private half of a generated key, once
          • Revoke an ssh key
        • Schema and objects
          • The SQL objects we put in it
          • Create one, and apply it
          • What is in the database, as the engine reports it
          • One table
          • What it would run, without running it
          • Redefine an object in place
          • Drop it
          • The extensions installed in it
        • Migrations
          • A plan compiled to statements, recording nothing
          • The migrations recorded for it
          • Record one
          • Apply everything recorded and not yet run
          • Apply everything pending, oldest version first
        • Lifecycle
          • Grow or shrink it
          • Stop it accepting connections
          • Start it again
          • Move it to another region
        • Backups and replicas
          • Take a backup
          • The backups it has
          • Restore one into it
          • What has been restored into it, and from where
          • Its read copies
          • Add one
        • Policies
          • The catalog
          • One policy
          • What this database is held to
          • Switch a policy on, or change its knobs
          • Switch it off
          • Mark the policies reviewed
          • Evaluate the periodic policies now
          • Who is behind a credential
        • Passwordless
          • The database's passwordless sessions
          • Issue a passwordless session (v1)
          • Revoke a passwordless session
          • Bind a session to a device key
          • Issue a v2 session for a host to bind
          • Redeem an enrolment ticket on the host
          • Check a passwordless credential
          • Run one described query under a passwordless credential
        • Database roles
          • The database's roles
          • Define a role
          • One role
          • Change what a role permits
          • Delete a role, and revoke every key granted it
          • Grant a role, which mints a key
          • Who holds a role
          • The api keys bound to a role
        • Pools
          • A database's connection pools, and how busy each is
          • Open another pool
          • Rename a pool or change its size
          • Close a pool
        • Data plane
          • Run a query against a database
          • Several statements, in order, over one connection
          • Is this database answering
          • What the proxy itself is holding
        • Transfers
          • The strategies this account's tier may use
          • Price a transfer without creating it
          • The account's transfer jobs, newest first
          • Create a transfer job
          • One job, and whether its certificate holds
          • Cancel an unfinished job
          • Start a created job, confirming its price
          • Report a job's status (the runner, or the owner's side of a local run)
        • Every database on the account
        • Provision a database
        • Change a database that is already running
        • One database
        • Deprovision it
        • Read or write it
        • Report what it is using
        • The engines this API will provision
        • Where a managed database can be put
    • Teams
      • Teams
        • Members
          • Who is on it
          • Invite somebody
          • Accept an invitation
          • Change somebody's role
          • Remove somebody
        • Projects
          • The projects a team runs
          • Start one
          • Rename a project, or move its environment
          • Delete a project
          • One project, and what is in it
          • Put a database or store in it
          • What is in a project
          • Take one out
        • The teams this account is on
        • Start one
        • The twelve roles, and what each may do
        • Rename a team
        • Close a team
        • One team
        • Hand the team to somebody else
        • Leave a team
    • Schemas
      • Error
      • ValidationErrors
      • Token
      • PolicyCategory
      • PolicySeverity
      • PolicyAction
      • PolicyTrigger
      • PolicyParam
      • Policy
      • PolicyCatalog
      • PolicyAssignment
      • PolicyOutcome
      • PolicyFiring
      • CredentialTrace
      • Relation
      • Restrictions
      • ChildSummary
      • SignupRequest
      • SigninRequest
      • UpdateMeRequest
      • User
      • Address
      • GeoPoint
      • D1Region
      • Usage
      • UsageReport
      • Resource
      • Database
      • DataStore
      • NewDatabase
      • NewDataStore
      • QueryRequest
      • DatabasePrivilege
      • ApiKey
      • DbUser
      • Access
      • AccessRequest
      • DatabaseObject
      • NewDatabaseObject
      • NewMigration
      • SchemaOperation
      • Migration
      • Operation
      • Session
      • AdminPowers
      • Admin
      • AuditEntry
      • TeamRole
      • Conversation
      • ChatMessage
      • TeamSso
      • Team
      • TeamMember
      • SshKey
      • ConnectionInfo
      • InboxAddress
      • InboxMailbox
      • InboxMessageSummary
      • InboxMessage
      • InboxNote
      • Page
      • Quote
      • Plan
      • ApiError
      • CapabilityRefusal
      • KlockErrorCode
      • PageWindow
      • SessionView
      • KlockStepUpRequest
      • KlockOpenRequest
      • KlockOpenedSession
      • UpdateMeResult
      • CapabilitiesView
      • SessionLimits
      • Device
      • DeviceListed
      • DeviceTeamRef
      • DeviceCommand
      • DeviceAuditLine
      • DeviceActionRequest
      • StaffActionRequest
      • ManagedSession
      • SessionRevoked
      • AccessRule
      • AccessRuleRequest
      • BehaviourProfile
      • BehaviourProfileRequest
      • BehaviourProfileSaved
      • BehaviourFinding
      • BehaviourFindingAck
      • StepUpProof
      • Removed
      • MemberLockdownRequest
      • McpClient
      • McpDelegatedView
      • McpToolCall
      • McpForwardRequest
      • PasswordlessScope
      • RoleScope
      • PasswordlessSession
      • PasswordlessTlsMaterial
      • PasswordlessKerberosMaterial
      • ServiceDeviceKeys
      • ServiceSession
      • DatabaseRole
      • TransferEndpoint
      • TransferJobRequest
      • TransferQuote
      • TransferStrategy
      • TransferJob
      • TransferJobAccess
      • Pool
      • PoolAllowance
      • BillingSubscription
      • Invoice
      • BillingContact
      • PaymentMethod
      • UpcomingCharges
      • TeamBilling
      • TeamKerberosRealm
      • TeamSsoDomain
      • TeamSsoResponse
      • StoreConnection
      • BatchFailure
      • ProxyStatus
  1. guides

Security in the console

The console (app.prod-orm.io) has a page for everything the CLI's klock
commands do: sessions, devices, access rules, behaviour profiles, MCP client
tokens, capabilities and lockdown, plus the team, database and staff views.
This page says where each one is. How each feature works is in the guides it
links to.
WhereWhat
web/src/consoles/basic/security/*Account security (#/security)
web/src/consoles/basic/auth/{CliLogin,Pair,Recovery}.tsxCLI sign-in, pairing, lock-out recovery
web/src/consoles/team/*The team page's security tabs
web/src/consoles/basic/database/access-rules/*The database page's Access rules tab
web/src/consoles/team/TeamBillingPanel.tsxThe team's billing account
web/src/consoles/admin/{AdminUserDetail,AdminKlock,MfaRequired}.tsxStaff views, and the E3 MFA prompt

Account security#

#/security?tab=<tab> has these tabs:
TabShows and doesCLI equivalent
SessionsEvery kind of session (browser, CLI, CLI token, trusted device, service, MCP client, staff), filtered by kind or live only. Each row shows its device, subject, check-in deadline, step-up time, frozen reason, limits and capabilities. Sign out; freeze (klock kinds, optional reason); unfreeze (asks for a TOTP code, or the password on an account without MFA). Sign out everywhere else ends your other person sessions and keeps service sessions (database hosts, CI, agents); sign those out one by one, or see below. Its CLI tokens card mints explicit personal tokens for --token / PRORM_TOKEN (CI, scripts); it sends purpose: "token", which E3 still allows, for 30 days at most. Key rotation is CLI-only.prorm sessions
DevicesYour devices with their key store (file-held keys are flagged as weaker), last sync and country, and state. Rename, suspend or reinstate, wipe (best effort, at the next sync), revoke. Pair a device opens #/pair. A row opens #/security/devices/:id: details, credentials, the sessions on the device and its audit trail.prorm devices
Two-factorTOTP enrolment, and removal, which asks for the password and a code from the authenticator app or a recovery code (see below). Admin accounts need a confirmed factor from E3.prorm security mfa enable, prorm security mfa disable
Access rulesAccount-scope rules, with report-only and enforced badges and expiry. A 409 would_lock_you_out offers "save anyway" behind a step-up. Test this request evaluates your rules in the browser, with the same engine as the API, against the request context the API reports or an IP and country you type. It is a preview; the API decides.prorm access
BehaviourFindings (acknowledge, or show acknowledged ones), profiles (edit, remove), and adding a profile from a preset with a JSON editor. New profiles start in report mode, and saving may ask for a step-up. The API validates profiles; the console does not.prorm behaviour
MCP clientsDelegated tokens: capabilities, database lock, last use, expiry. Create one with a capability picker (only delegable capabilities you hold; quick picks "Docs only", "Read my data", "Read and write data"), for 1, 7 or 30 days, optionally locked to one database. The token is shown once, with MCP settings JSON ready to paste. At most 5 are live; a sixth replaces the least recently used.prorm mcp clients
CapabilitiesGET /me/capabilities: tier, session kind and binding, plan, team role, staff scopes, capabilities by group, dormant capabilities, each team's role capabilities, and limits by session kind. A Step up now card.prorm whoami --caps, prorm step-up
Audit logThe account's audit trail.prorm security audit
Danger zoneEmergency lockdown: type LOCKDOWN, optionally include service sessions, step up. It signs this browser out too. Release is here as well.prorm lockdown
See klock for sessions and devices,
Access rules and behaviour profiles for
rules, profiles, lockdown and recovery, MCP for client tokens,
and Capabilities for tiers and step-up.

Signing out everywhere#

"Sign out everywhere else" (DELETE /security/sessions) spares service
sessions
: a database host, a CI runner or an agent keeps working when you
sign your people sessions out. A password reset does the same. To end them
too, revoke each service row on the Sessions tab, use the lockdown's
"include service sessions" box, or call the API with includeServices:
See signing out everywhere for the
exact rule and the staff routes.

Removing the second factor#

Removing a confirmed TOTP factor (DELETE /security/mfa) needs the current
password and the second factor itself: a six-digit code from the
authenticator app, or a recovery code. The code is spent. The console's
removal dialog and prorm security mfa disable ask for both:
$ prorm security mfa disable
Current password:
Code from the app, or a recovery code (empty if never confirmed): 492 017
✓ Two-factor is off.
Without a code the API answers 401 with { "mfaRequired": true }.
Wrong passwords and wrong codes both count toward the step-up lockout; once
it is reached the route answers 429.
An enrolment that was never confirmed is still removed with the password
alone, so leave the code empty there.
Before 4.9.2 the password alone removed the factor
(PRORM-SA-2026-067).

Email addresses#

Every address on an account is confirmed with a six-digit code mailed to it
(POST /me/emails/:id/verify, and /resend for a new code). A code expires
after 15 minutes and allows 5 attempts; each address also has a daily budget
of wrong guesses and of codes sent, and too many answer 429 with
Retry-After. Only a verified address reserves the address, can become the
login address, or is used by team single sign-on.
To change the login address, send the new one with PUT /me. It answers
202 with emailVerification (pending: true), leaves the login address as
it is, and mails the code to the new address and a notice to the current one.
Entering that code makes the new address the login address at once; both
addresses are told, and the change is audited. A request lapses after 24
hours: a later code confirms the address but does not switch to it. Addresses
added with POST /me/emails are only confirmed, never promoted; make one the
login address with PUT /me/emails/:id/primary once it is verified.
[!NOTE]
These are control-plane changes on feat/klock-capabilities (API 3930e9d,
and 7386d41 for the PUT /me flow;
PRORM-SA-2026-024). No
address that existed before was marked verified, so confirm yours with
resend, then verify. Password sign-in is not affected. Earlier
builds of the fix needed PUT /me/emails/:id/primary after the code, and
the 202 carried promoteAt; neither is needed now.

Team single sign-on#

A team's SSO domains admit nobody until each is proved with a DNS TXT
record, and domains that existed before the change are pending again until
they are proved. SSO identities belong to the issuer that created them, so
changing the issuer is audited and the old issuer's identities stop working.
An existing account joins SSO only through a subject it linked before,
POST /sso/link from a session that passed password and MFA, or, automatically,
when the team's own SSO created it and its address is verified at a proved
domain (PRORM-SA-2026-001).
The API only talks to a provider at a public address. The issuer and every
endpoint its discovery document names must be https at a public host; the
host name is resolved once, every address is checked (loopback, private,
link-local, CGNAT, multicast, reserved and documentation ranges, and the IPv6
forms that embed them, are refused), and the request is sent to the checked
address, so a second lookup cannot redirect it. Redirects and responses over
1 MiB are refused, and SSO errors no longer include the provider's HTTP status.
An issuer or endpoint that fails the check gets 400
(PRORM-SA-2026-063).

Signing in, pairing and recovery#

#/cli: CLI sign-in. prorm login opens it with the port, state,
hostname and, for klock v2, the device keys and confirm code. The page
shows the six-character code (as KXQ 7M2), and you must tick "My terminal
shows …" before "Yes, the codes match". "The codes do not match" aborts
with a warning. kind=device asks "Trust this device?" and a step-up. The
grant goes to the CLI's loopback listener, or through the relay when the
browser cannot reach 127.0.0.1. When the API offers no v2, the console
falls back to a legacy 30-day token; a CLI that has signed in with v2
before refuses it unless you run prorm login --legacy. Under E3 the API
answers a v1 link with 410 login_v2_required, and the page shows
Update the CLI to sign in: nothing is signed in, and it tells you to
update prorm and run prorm login again, or to mint a token under
Security › Sessions › CLI tokens for a script. The full flow is in
the CLI guide.
#/pair: approve a pairing. Signed in, enter the code that
prorm login --pair shows on the new device (KXQ7-M2PD), or open the
#/pair?p=…&c=… link from its QR code, and approve it as a trusted device
or a session. See pairing.
#/recover: lock-out recovery. Public. Enter your email; the link it
sends (valid 30 minutes, once) brings you back with a code. Then give your
password, and a TOTP code if you have MFA, for a one-hour recovery session
that lands on Security › Access rules with a banner.

CLI sign-in, both sides#

The terminal:
$ prorm login
Confirm code: KXQ7M2   (the console shows the same code — approve only if they match)
Sign in in the browser to connect this CLI:
  https://app.prod-orm.io/#/cli?port=53127&state=…&host=ada-mbp&v=2&dpk=…&spk=…&sb=…&cc=KXQ7M2
✓ Signed in as ada (ada@example.com) on this device (dev_Q4M8…).
klock v2 interactive session · key in the macOS Keychain · ~/.prorm/klock/default.klock
Check in by 28/09/2026, 11:00:00; the session ends 28/10/2026, 10:00:00.
The browser shows Sign the CLI in? with KXQ 7M2. What happens between
them:
A grant parked at the relay is useless without the device key it names, so
nothing secret ever sits in a URL.
[!CAUTION]
Approve only a code that your own terminal shows. Never approve a
sign-in or pairing code that someone read out, emailed or messaged to you:
that is how a device key on their machine gets a session on your account.

Pairing a device from the console#

Start the pairing on the new device#

$ prorm login --pair
Pairing code: KXQ7-M2PD
On a signed-in device: prorm devices approve KXQ7-M2PD   (or the console, Security → Devices)
The CLI waits for an approval until the pairing expires (ten minutes when
the service gives no expiry), then gives up with The pairing was not approved in time.

Approve it where you are already signed in#

Open Security › Devices › Pair a device (#/pair), type KXQ7-M2PD or
scan the QR code, and choose a trusted device or a session. A trusted device
needs a step-up.

Check the new device#

The new device prints ✓ Signed in as …. The device then appears in
Security › Devices, with its key store; a file-held key is flagged.

Recovering from a bad access rule#

Ask for a link#

Open #/recover ("Locked out by an access rule?") and enter your email. The
answer is the same whether or not the address has an account.

Open the link within 30 minutes#

The link works once. It brings you back to Recover your account with the
recovery code filled in.

Prove it is you#

Give your password, and an authenticator code if the account has one. You get
a one-hour browser session that skips account rules only, and the
account's block rules are switched to report mode with the note
recovery: pending review.

Fix the rules#

You land on Security › Access rules. Remove the rule that locked you out.
The block rules marked recovery: pending review keep reporting until you
replace them: a rule cannot be edited, so remove each one you still want and
add it again. See recovery.

Teams#

The team page (#/teams/:id?tab=<tab>) adds these tabs:
TabShows and doesNeeds
ResourcesEverything reached through the team, and Create in this team. A resource created here is owned and billed by the team, counts against the team's plan, and survives its creator leaving.resource:provision on the team to create
DevicesMembers' devices and their sessions in the team context. Revoking needs a reason, and the member is emailed. A step_up_required answer asks for a TOTP code (or password) and retries.device:manage-members, session:manage-members
AccessTeam access rules, mandatory by default, so members cannot widen them. Every member can read them.access-rule:team to write
BehaviourTeam behaviour profiles, from a preset or JSON; report mode by default.behaviour:team to write
BillingThe team's own billing account (TeamBillingPanel): see below.billing:read to see, billing:manage to change
See team-owned resources.

Team › Billing#

A resource created in a team is the team's, and the team pays for it, not the
member who created it. The Billing tab is the team's account, with the
routes in a team's billing account:
CardShows and does
PlanThe plan and subscription, the monthly estimate and pool use. Before the team pays: Start paying (Stripe Checkout, with an optional membership). After: Change plan (free, usage, membership; it says "pending" until Stripe confirms) and Stripe portal.
Who paysThe billing contact, picked from members whose role can read billing; empty means the owner.
Transfer billingTeam transfers are charged to the team's card, not the member's.
Payment methodsThe team's cards: add one (a Stripe-hosted page), make one the default, remove one.
This monthThe lines the team's next invoice will have for its own resources.
InvoicesEvery invoice Stripe has raised on the team's account.
Members with billing:read (owner, admin, billing) see the tab; only
owner and billing can change anything. On a deployment with no Stripe
configuration the actions are disabled and the API answers 503. Against an API without the team billing routes, the tab
shows transfer billing and "Team billing is coming soon".

Databases#

The database page has an Access rules tab: database-scope rules (allow or
block by IP, country, ASN, device, certificate, principal, time, client or API
key), with optional capability patterns, expiry, a note, and enforce now
(otherwise a new block rule reports for 24 hours first). Rules are checked in
the browser with the shared engine before they are sent, and
would_lock_you_out offers "save anyway" behind a step-up. Addresses in the
legacy blockedIps list with no matching block rule appear as read-only
legacy rows. The engine firewall (allowedIps) is shown beside the rules
as "Network (engine firewall)", read-only; edit it on the Access tab.

Staff#

For prorm staff only:
Account page. Sessions (every kind) and Devices sections. With
the support scope, a staff member can revoke a session, or revoke or wipe
a device. Each needs a reason of 10–500 characters and a TOTP step-up in the
same dialog, before anything is sent (there is no password fallback). The
account holder is emailed, and the action is audited at level alert.
Mandatory MFA. Under E3, every staff route answers an admin without a
confirmed TOTP factor with 403 mfa_required. The staff console shows
Staff accounts need a second factor instead of "not an admin", lists the
setup and confirm routes the API named, and enrols right there (the
/security/mfa/* routes are the account's own). Try again reloads the
admin's access once the factor is confirmed. From a terminal:
prorm security mfa enable.
Admin › Klock (#/admin/klock, scopes support or users), read-only:
the service configuration (/.well-known/klock-configuration), the keyset
(seq, dates, keys, and a warning within 14 days of expiry), the revocation
feed, and the device fleet overview. Authority and CA health show "coming
soon".

When a feature is not there#

Every klock page shows "X is coming soon" instead of an error when the server
answers 501, 405, not_implemented or its catch-all 404, and "X is not
configured" on a 503 (for example klock_unconfigured when the API has no
klock service binding). A 401 step_up_required does not sign you out: the
page asks for your authenticator code and retries.

Related reading#

klock: sessions, devices, pairing, the klock service
Capabilities
Access rules and behaviour profiles
MCP
CLI
Modified at 2026-10-04 00:40:16
Previous
Connection Pooling & Performance
Next
Couchbase: structured N1QL queries
Built with