Roles
Every Gateway WebSocket client connects with one role:operator: control-plane clients such as CLI, Control UI, automation, and trusted helper processes.node: capability hosts (macOS, iOS, Android, headless) that expose commands throughnode.invoke.
operator role; node-originated methods
require the node role.
Scope levels
Unknown future
operator.* scopes require an exact match unless the caller
already holds operator.admin.
Identity scope grants
gateway.auth.identityScopes grants operator scopes to verified user
identities from trusted-proxy auth or Tailscale WhoIs:
- For trusted-proxy Control UI connections,
x-openclaw-scopesfirst caps device enrollment or upgrade requests. Device authorization then establishes the persistent scopes; a device-less session contributes no self-declared scopes. - OpenClaw unions a matching server-side identity grant with those scopes.
- OpenClaw applies
x-openclaw-scopesto the final union as the session cap. An absent header means no cap; a present-but-empty header yields no scopes.
hello.auth.scopes and Gateway method
authorization. Identity grants are session-only: they do not create or modify
pairing records or request a device scope upgrade. Token, password, and no-auth
connections carry no verified identity and receive no grant.
Identity grants apply only to operator-role connections; node-role connections never receive them.
Method scope is only the first gate
Each Gateway RPC has a least-privilege method scope that decides whether a request reaches its handler. Params-aware methods derive that scope before dispatch so authorization failures have one canonical structured response:agentneedsoperator.writefor ordinary turns andoperator.adminfor/newor/resetsession lifecycle commands.node.invokeneedsoperator.writefor ordinary relay commands andoperator.adminwhen relayingbrowser.proxy,browser.proxy.upload.v1,fs.listDir, orterminal.uploadto a node.- The top-level
fs.listDirRPC needsoperator.writefor Gateway-host requests andoperator.adminwhennodeIdtargets a node. Its handler limits non-admin Gateway-host browsing to configured agent workspaces. sessions.createneedsoperator.writefor ordinary creation, including aprojectId, andoperator.adminfor incognito sessions or anyexecNoderequest. For non-admin callers, the handler limitscwdto configured agent workspaces;projectIdcannot be combined withcwdorexecNode.environments.listneedsoperator.read. Session placement methods derive their scope from the requested target before schema validation:sessions.dispatchneedsoperator.writefordeviceIdandoperator.adminforprofileIdor a target-lesscloudWorkers.projectProfileslookup;sessions.moveneedsoperator.writefor Gateway or device targets andoperator.adminfor profile targets;abandonSource: trueremainsoperator.writebut is schema-valid only with a Gateway target and runtime-valid only for an exact offline device source;sessions.reclaimremainsoperator.write. Malformed dispatch params or a malformed move target useoperator.writeso the handler can return the precise schema error. All three methods retain session ownership, participation, and commit-time revalidation fences.operator.readalone cannot start, stop, or move a session. Cloud profile allocation and mutation, pairing and Connect machine, rawenvironments.createorenvironments.destroy, incognito sessions, directexecNodeexecution, and arbitrary host or node paths remainoperator.admin.worktrees.branchesneedsoperator.write. Its handler limits non-admin callers to workspace-contained paths or registered-project roots; other host paths requireoperator.admin.talk.configneedsoperator.read;includeSecrets: truealso needsoperator.talk.secrets.talk.client.*,talk.session.*,talk.speak, andtalk.modeneedoperator.talk(or the compatible broaderoperator.write).sessions.patchneedsoperator.writefor session organization fields and the per-sessionmodeloverride. Other runtime overrides, including thinking, fast, verbose, trace, and reasoning levels, needoperator.admin. Persisting a selected model as the configured agent default is also admin-only.
Some handlers then apply stricter checks based on the concrete thing being
approved or mutated:
device.pair.approveis reachable withoperator.pairing, but approving an operator device can only mint or preserve scopes the caller already holds.node.pair.approveis reachable withoperator.pairing, then derives extra approval scopes from the pending node’s declared command list.chat.sendis a write-scoped method, but the/config setand/config unsetchat commands requireoperator.adminon top of that, regardless of the caller’s chat-send scope.
client.id or client.mode. Client
identity can still affect connection and device-auth policy, but it neither
grants nor removes session mutation authority.
audit.run.inspect intentionally uses operator.read. Every client with that
scope in a Gateway operator domain may receive the retained execution-identity
context, including bounded pseudonymized references and secret-redacted display
labels. operator.read is not a per-user or hostile multi-tenant privacy
boundary. Operators who must keep this data separate need separate Gateway
trust domains.
Device pairing approvals
Device pairing records are the durable source of approved roles and scopes. An already-paired device does not get broader access silently: a reconnect that asks for a broader role or broader scopes creates a new pending upgrade request. A connected limited Control UI can file that same pending request through its Request admin banner without attempting a broader reconnect. The banner can collapse into a persistent Limited access chip that reopens the action. The request is bound to the signed device identity on the live connection. Approval still comes fromdevice.pair.approve and therefore requires operator.pairing plus
authority for every requested scope. After approval rotates the operator token,
the Gateway returns the new token only to that device’s live waiter; the browser
stores it before reconnecting. Canceling the wait or disconnecting before
approval falls back to the ordinary pairing repair flow on the next connection.
The explicit exception is the administrator-capable Control UI owner profile
issued directly on the Gateway host by openclaw dashboard or graphical
onboarding. Its short-lived, single-use bootstrap can approve the exact closed
scope set for a fresh browser or upgrade an existing limited credential only
when it binds to that same signed browser keypair. Generic Control UI and
Telegram handoffs, mobile setup profiles, shared credentials, locality, and
caller-selected scopes do not receive this exception.
Approving a device request:
- A request with no operator role does not need operator scope approval.
- A request for a non-operator device role (for example
node) requiresoperator.admin, even thoughdevice.pair.approveitself only needsoperator.pairing. - A request for
operator.read,operator.write,operator.approvals,operator.questions,operator.pairing,operator.talk, oroperator.talk.secretsrequires the caller to already hold that scope, oroperator.admin. - A request for
operator.adminrequiresoperator.admin. - A repair request with no explicit scopes can inherit the existing operator
token’s scopes; if that token is admin-scoped, approval still requires
operator.admin.
operator.pairing.
For paired-device token sessions, management is self-scoped unless the caller
has operator.admin: a non-admin caller sees only its own pairing entries, and
can approve, reject, rotate, revoke, or remove only its own device entry.
Node pairing approvals
node.pair.* capability approvals are stored on the paired device record in
the shared SQLite pairing store. Gateways migrate any remaining entries from
the retired standalone nodes/paired.json store into those records once at
startup. See Gateway pairing for details.
node.pair.approve derives extra required scopes from the pending request’s
command list:
Here,
fs.listDir is the node command declared for relay through node.invoke,
not the top-level Gateway RPC described above.
Approving a node declaration records its command surface. For computer.act,
the node advertises that surface only after Computer Control is enabled locally;
once the pairing update is approved, invoking it through node.invoke requires
write scope but not admin scope for each action. Commands classified as
dangerous or privacy-heavy still require a persistent
gateway.nodes.commands.allow entry in addition to pairing.
Node pairing establishes identity and trust; it does not replace a node’s own
system.run exec approval policy.
Shared-secret auth
Shared gateway token/password auth is treated as trusted operator access for that Gateway. OpenAI-compatible HTTP surfaces,/tools/invoke, and HTTP
session-history endpoints restore the full default operator scope set for
shared-secret bearer auth, even if a caller sends narrower declared scopes.
Identity-bearing modes, such as trusted proxy auth or private-ingress none,
can still honor explicit declared scopes. Use separate Gateways for real trust
boundary separation.