Skip to main content

Permissions

Lumio uses role-based access control (RBAC) to manage what each team member can do within an account.

How It Works

Each account has roles (e.g., Owner, Moderator, Viewer). Each role has a set of permissions. When a user performs an action, the system checks if their role grants the required permission.

Permission checks run on all four protocol surfaces with the same resource:action strings:

  • RESTrequire_permission() in route handlers
  • GraphQLPermissionGuard on resolvers
  • WebSocket — channel-subscribe gate in crates/lo-websocket/src/gate.rs
  • Frontend<Gate permission> and hasPerm() in client code

The WebSocket layer maps each channel type to one of several gate kinds — a resource:action permission on the account in the channel name, a user-scoped permission, plain account scoping, a bound token type, or public. Most account-scoped streams use a :read permission (chat:\{account_id\}chat:read, events:\{account_id\}events:read). See WebSocket → RBAC gate for the full mapping. A caller that fails the gate receives code: "UNAUTHORIZED" on subscribe.

Default Roles

Four roles are seeded for every new account, in this sort order: Owner, Administrator, Moderator, Viewer.

Owner (owner)

Full account access. System role (is_system: true, cannot be deleted). Holds every account permission — the list is loaded explicitly, not via a wildcard.

Administrator (administrator)

Everything Owner holds except account:delete, plan:read, plan:edit, and extension-dev:payouts. Account dissolution and plan changes are additionally enforced through an owner_id check rather than a permission.

Moderator (moderator)

Chat moderation, event monitoring, Spotify playback control, and read access across the rest of the account.

CategoryPermissions
Eventsevents:read, events:create, events:userinfo
Overlaysoverlays:read
Spotifyspotify:read, spotify:playback, spotify:queue, spotify:playlist, spotify:device
Chatchat:read, chat:write, chat:userinfo, chat:delete, chat:ban, chat:timeout, chat:notes, chat:raid, chat:refresh_user, chat:poll, chat:prediction
Connectionsconnections:read
Uploadsuploads:read
Rewardsrewards:read
Automationsautomations:read, automations:execute
Members & Rolesmembers:read, roles:read
OBSobs:read
Copyrightcopyright:vote, copyright:report, copyright:recommend
Botbot-modules:read, bot-connections:read, bot-commands:read
Extensionsextension-store:read, extension-store:review, extension-data:read
Widgetswidgets:read
Soundssounds:read, sounds:play
Stream Historyhistory:read, history:export
Public Statspublic-stats:read

Viewer (viewer)

Read-only access.

CategoryPermissions
Eventsevents:read, events:userinfo
Overlaysoverlays:read
Bot Commandsbot-commands:read
Extensionsextension-store:read, extension-store:review, extension-data:read
Widgetswidgets:read
Soundssounds:read

Custom roles can be created under Dashboard > Settings > Roles.

Permission Reference

The registry holds 123 account permissions. A couple are assignable and seeded on the default roles but the API does not re-check them — the dashboard <Gate permission> hides the UI, but the endpoints do not gate on them, so assigning or withholding them changes nothing on the API surface:

PermissionWhere it takes effect
events:userinfo, connections:editDashboard only — <Gate permission> hides the UI; the API does not re-check them

sessions:read/sessions:delete, automations:history, and events:delete were removed from the account registry in ZAF-1094 — they gated nothing (session management is self-scoped, there is no automation-history surface, and only the system retention sweep deletes events). copyright:report/copyright:recommend are not unenforced: they carry a PermissionGuard on the GraphQL mutations createCopyrightReport / createSafeRecommendation. There is simply no dedicated REST route — reporting and recommending both go through POST /v1/copyright/vote under copyright:vote.

The account role editor (GET /v1/roles/permissions and the GraphQL accountPermissions query) exposes exactly the account permissions listed below — the picker and the create/update validation registry share one source of truth (get_all_account_permission_infos()), so every permission you can assign is visible and vice-versa (ZAF-231). The admin panel's per-user and per-account permission-override pickers draw from the same source via the adminAssignablePermissions query (proxied as GET /api/assignable-permissions), so they list this exact set too and cannot drift (ZAF-430).

Events

PermissionDescription
events:readView events, notifications, and event history
events:createSend test events and manage notifications
events:userinfoView user cards and profiles from event entries

Overlays

PermissionDescription
overlays:readView overlay configurations
overlays:createCreate new overlays
overlays:editEdit existing overlays
overlays:deleteDelete overlays
overlays:access-readRead per-overlay access entries/candidates and see all overlays (access-manager visibility)
overlays:access-grantGrant (set) per-overlay access for a user
overlays:access-revokeRevoke per-overlay access for a user

Widgets

PermissionDescription
widgets:readView widget instances
widgets:createCreate and duplicate widget instances
widgets:editEdit widget configuration
widgets:deleteDelete widget instances
widgets:access-readRead per-widget access entries/candidates and bypass per-widget restrictions (access-manager visibility)
widgets:access-grantGrant (set) per-widget access for a user
widgets:access-revokeRevoke per-widget access for a user

Extension Data

Gates direct account-actor calls to an installed extension's server functions (dashboard editor, lumio run CLI). Widget runtime calls authenticated by an Extension Token are governed by the install's own scope and are not gated by these permissions.

PermissionDescription
extension-data:readRead installed-extension data via query functions (queryRows, query-category handlers)
extension-data:editMutate installed-extension data via insertRow / patchRow / deleteRow and mutation/action handlers

Spotify

PermissionDescription
spotify:readView now playing state, queue, devices, playlists, and search tracks
spotify:playbackControl playback: play, pause, skip, previous, seek, shuffle, repeat
spotify:volumeChange playback volume (gates the volume slider in the dashboard and popout player)
spotify:queueAdd tracks to the playback queue
spotify:playlistManage playlists: create, rename, delete, add/remove tracks, start playlist playback
spotify:deviceTransfer playback between Spotify devices
spotify:workerStart and stop the manual Spotify worker connect

Chat

PermissionDescription
chat:readView chat messages, history, and emotes
chat:writeSend chat messages
chat:userinfoView user profiles, follow status, and moderation log
chat:deleteDelete chat messages
chat:banBan and unban users
chat:timeoutTimeout users
chat:notesView and manage user notes
chat:raidCancel active raids
chat:pollEnd active polls
chat:predictionEnd active predictions
chat:refresh_userManually refresh a user's platform profile data

Connections

PermissionDescription
connections:readView connected platforms and credentials
connections:createConnect new platforms
connections:editUpdate connection credentials
connections:deleteDisconnect platforms

Settings

PermissionDescription
settings:readView account settings
settings:editModify account settings

Automations

PermissionDescription
automations:readView automations and their configuration
automations:createCreate new automations
automations:editEdit automation metadata, nodes, edges
automations:deleteDelete automations
automations:executeManually trigger and start/stop automations

Members

PermissionDescription
members:readView the members list and all invitations
members:createCreate invites, search users for direct invites
members:editChange member roles, create/edit/delete custom roles
members:deleteRemove members from the account, revoke pending invites

Uploads

PermissionDescription
uploads:readView uploaded files
uploads:createUpload new files
uploads:deleteDelete uploaded files

Rewards

PermissionDescription
rewards:readView channel point rewards
rewards:createCreate new rewards
rewards:editEdit existing rewards
rewards:deleteDelete rewards

Tokens

PermissionDescription
tokens:readView popout tokens
tokens:createCreate popout tokens
tokens:editEdit popout tokens
tokens:deleteRevoke popout tokens

API Keys

Personal user API keys (lm_usr_…) and account service keys (lm_svc_…) share one dedicated permission family, separate from popout tokens.

PermissionDescription
apikeys:readView API keys (personal lm_usr_ and account service lm_svc_)
apikeys:createCreate an API key (personal or account service key)
apikeys:editRename an API key (label only)
apikeys:deleteRevoke an API key

tokens:create, tokens:edit and apikeys:create only let a caller mint or edit a token/key within their own permissions: it can never be granted a permission the caller does not currently hold. Requesting one is rejected with FORBIDDEN, identically on GraphQL and REST. A resource:* grant (system keys only) lets the caller grant any action under that resource; a bare *:* / * is not a global wildcard (it grants nothing beyond a literal *:* / *).

Account

PermissionDescription
account:readView account settings and information
account:editEdit account settings (name, etc.)
account:deleteDissolve (permanently delete) the account

Plan

PermissionDescription
plan:readView account plan and billing information
plan:editChange account plan, manage subscription

Login Assignments

Assignable to account roles, but enforced at the user level: own assignments are always allowed for any authenticated user, and these permissions only gate actions taken on behalf of other users on the account.

PermissionDescription
login-assignments:readView login assignments for the active account. Own assignments are always visible without this permission.
login-assignments:createAssign a login connection to an account on behalf of another user. Own assignments are always allowed without this permission.
login-assignments:deleteRemove a login assignment for the active account on behalf of another user. Own assignments are always removable without this permission.

Sessions

Session management is not an account-role permission. Every authenticated user can view and revoke their own active browser sessions regardless of account role (and with no active account selected). The surface is own-scoped on both GraphQL (sessions / deleteSession / deleteAllOtherSessions) and REST (GET / DELETE /v1/users/me/sessions): the acting user's own id selects the rows, and the only gate is the first-party principal check (ZAF-469 / ZAF-516). The former sessions:read / sessions:delete role permissions were removed in ZAF-1094 — they gated nothing.

Extension Developer

Extension developer permissions gate access to the developer dashboard and extension management. They are assignable to account roles and are also exercised through developer team RBAC. See Team-Scoped Permissions for the team permission model.

PermissionDescription
extension-dev:readView extension developer dashboard and owned extensions
extension-dev:createCreate new extensions
extension-dev:editEdit owned extensions (metadata, code, assets)
extension-dev:deleteDelete owned extensions
extension-dev:publishSubmit extensions for review and publish approved versions
extension-dev:analyticsView extension analytics (installs, usage, ratings)
extension-dev:payoutsManage extension revenue payouts

Sounds

PermissionDescription
sounds:readView sounds
sounds:createUpload sounds
sounds:editEdit sound metadata
sounds:deleteDelete sounds
sounds:playPlay sounds in browser sources

Bot Modules

PermissionDescription
bot-modules:readView bot module configurations
bot-modules:editEdit bot module configurations
PermissionDescription
copyright:readView safe/blocked songs, copyright check results
copyright:editAdd to this account's safe/blocked lists, import playlists
copyright:deleteRemove entries from safe/blocked lists
copyright:voteVote on community copyright-status candidates
copyright:reportReport a song's copyright status — GraphQL createCopyrightReport (PermissionGuard); no dedicated REST route (reporting goes through POST /v1/copyright/vote under copyright:vote)
copyright:recommendRecommend songs for the global list — GraphQL createSafeRecommendation (PermissionGuard); no dedicated REST route (recommending goes through POST /v1/copyright/vote under copyright:vote)

copyright:moderate is not an account permission — it is admin-scope (platform operator). See Admin: Copyright Moderation. It was moved out of account scope in ZAF-742 because approving/dismissing vote candidates writes the account-less global catalogue.

OBS

PermissionDescription
obs:readView OBS integration configuration and status
obs:editEdit OBS integration settings and remote control
obs:deleteDelete the account's OBS integration configuration

Roles

PermissionDescription
roles:readView account roles and the assignable-permission catalog
roles:editCreate and edit custom account roles
roles:deleteDelete custom account roles (system roles are protected server-side)

Role create/update validates every permission string against the account registry. A wildcard (resource:* / *:*) is rejected on both REST and GraphQL and can never be persisted into an account role.

Bot Commands

PermissionDescription
bot-commands:readView chat commands and their per-platform overrides
bot-commands:createCreate chat commands
bot-commands:editEdit chat commands and set overrides
bot-commands:deleteDelete chat commands and clear overrides

Bot Connections

PermissionDescription
bot-connections:readView the account's custom bot identities
bot-connections:createStart and complete the custom bot OAuth flow
bot-connections:deleteRemove a custom bot identity

Declared in both account and admin scope with the same string; the admin-scope copy gates system-level bot connections through require_admin_permission.

StreamElements

PermissionDescription
se-tokens:readView stored StreamElements JWT tokens
se-tokens:createStore a StreamElements JWT token
se-tokens:deleteDelete a stored StreamElements JWT token

Extension Store

PermissionDescription
extension-store:readBrowse the extension store and view installed extensions
extension-store:installInstall an extension into the account
extension-store:uninstallUninstall an extension from the account
extension-store:configureChange an installed extension's configuration
extension-store:reviewWrite store reviews and ratings

Stream History

PermissionDescription
history:readView stream/session history, reports and stats
history:shareCreate, extend and revoke shareable report links
history:exportExport history reports (CSV/PDF/TXT/JSON)
history:deleteDelete stored history sessions

Default roles: Owner and Administrator hold all four; Moderator holds history:read + history:export; Viewer holds none. Gated behind the feature:stream_history feature flag.

Public Stats

PermissionDescription
public-stats:readView this account's channel publicness settings for the public Stats app
public-stats:editToggle a channel's publicness / chatter-leaderboard suppression (opt-out / opt-in)

Default roles: Owner and Administrator hold both; Moderator holds public-stats:read; Viewer holds none. Gated behind the feature:public_stats_page feature flag.

Crawler control moved to admin scope (ZAF-725). The five crawler:* permissions that steer the platform-wide stats crawler are admin-scope (platform-operator) permissions, not account permissions — see Admin: Crawler below.

Audit Log

PermissionDescription
audit-log:readRead this account's audit log (GET /v1/account/audit-log / accountAuditLog) — role/permission changes, member-role assignment, channel connections

Default roles: Owner and Administrator hold it; Moderator and Viewer hold none. This account-scope audit-log:read is a distinct permission from the identically-named admin-scope audit-log:read (see Admin: Support, Audit & StreamElements): the account grant reads a single account's log through require_permission, the admin grant reads the operator audit surface through require_admin_permission, and holding one never unlocks the other.

Admin-Scope Permissions

Admin-scope permissions are checked against a user's admin role (not their account role). They gate the Lumio admin panel — /admin. The dashboard entry gate is admin:access, which is automatically included in every admin role.

Note: Some permissions (marked below) share an identical string with an account-scope permission but are enforced in a different context (require_admin_permission vs require_permission). This mirrors the bot-connections:* precedent.

Admin: Core Access

PermissionDescription
admin:accessDashboard entry gate. Auto-injected into every admin role.

Admin: Role Management

PermissionDescription
admin-roles:readView admin roles, their permissions, and member lists
admin-roles:createCreate new admin roles
admin-roles:editEdit role name, description, permissions, and user assignments
admin-roles:deleteDelete admin roles (is_system roles are protected server-side)

Admin: Privacy

PermissionDescription
admin:privacy-eraseErase persisted personal data on subject request (GDPR Art. 17). Powers DELETE /v1/admin/privacy/youtube/member/{id} (clears a YouTube member's cached records and their historical chat rows across all accounts) and POST /v1/admin/privacy/chat/erase (erases a data subject's platform_chat_messages across all accounts, by Lumio user id or platform+user_id). Reserved for support tooling; assigned only to system_admin.

Admin: Developer Verifications

PermissionDescription
developer-verification:readView developer applications and their details
developer-verification:editApprove or reject developer applications

Admin: Feature Flags

PermissionDescription
features:readView feature flags
features:editToggle feature flags
feature-flags:readView the feature-flag registry detail view
feature-flags:editEdit feature-flag metadata (category, description, plan defaults)

Admin: Users & Accounts

PermissionDescription
users:readView users, login connections, and membership details
users:editEdit user display name, email, overrides, and manage login connections
users:deleteDelete users
accounts:readView account details, limits, features
accounts:editUpdate account name, plan, limits, feature overrides, members, reconnect flags, and primary connections
accounts:deleteDelete accounts
accounts:overrides-readRead per-account permission overrides
accounts:overrides-editSet or remove per-account permission overrides

Admin: Providers & Platforms

PermissionDescription
providers:readView platform provider configurations
providers:editToggle providers and sub-flags
platforms:readView platform connection configuration
platforms:editEdit platform connection configuration

Admin: Infrastructure

PermissionDescription
system-keys:readView system API keys
system-keys:createCreate system API keys
system-keys:deleteDelete system API keys
oauth-clients:readView OAuth client registrations
oauth-clients:createCreate OAuth clients
oauth-clients:editEdit OAuth clients
oauth-clients:deleteDelete OAuth clients
system-connections:readView system-level platform connections
system-connections:editCreate and update system-level platform connections
system-connections:deleteDelete system-level platform connections

Admin: Billing, Plans & Coupons

PermissionDescription
billing:readView billing data
billing:editModify billing data
plans:readView plans
plans:createCreate plans
plans:editEdit plans and their feature mappings
plans:deleteDelete plans
subscriptions:readView subscriptions
subscriptions:editModify subscriptions
coupons:readView coupons
coupons:createCreate coupons
coupons:editEdit coupons
coupons:deleteDelete coupons

Admin: Bot Control & Commands

PermissionDescription
bot-control:readView bot enabled/disabled status across all accounts
bot-control:editToggle the bot on or off for an account
bot-commands:readView chat commands across all accounts
bot-commands:createCreate chat commands on any account
bot-commands:editEdit chat commands on any account
bot-commands:deleteDelete chat commands on any account
bot-connections:readView system bot connections
bot-connections:createCreate system bot connections
bot-connections:deleteDelete system bot connections
discord-guilds:readView Discord guild connections across all accounts
discord-guilds:deleteDelete a Discord guild connection

Admin: Support, Audit & StreamElements

PermissionDescription
support:readView support tickets
support:editHandle support tickets
audit:readRead the audit log
audit-log:readRead the admin (system-scope) audit log (GET /v1/admin/audit-log). Distinct from the identically-named account-scope audit-log:read, which reads a single account's log via require_permission; this admin copy is checked via require_admin_permission and holding one never unlocks the other.
csp-reports:readRead the CSP-violation calibration aggregate — cspViolationReports / REST GET /v1/admin/csp-reports. Distinct (violated_directive, blocked_host) pairs with counts, from the capped csp_violation_reports TimescaleDB table (≤5000 pairs, ≤30 d rolling). Admin-scope (platform operator) — seeded to system_admin, not assignable to any tenant role (ZAF-1051).
se-tokens:readView StreamElements tokens across all accounts
se-tokens:deleteDelete a StreamElements token on any account

Admin: Extensions & Developers

PermissionDescription
extension-review:readView the extension review queue and submission details
extension-review:editApprove, reject, or request changes on extension submissions
developer-limits:readView developer rate limits and quotas
developer-limits:editEdit developer rate limits and quotas

Admin: Ideas Moderation

PermissionDescription
ideas:moderate_readView all ideas with moderation details (reports, flags, internal notes)
ideas:moderate_statusChange idea status (approve, reject, mark as planned, close)
ideas:moderate_editEdit any idea regardless of ownership
ideas:moderate_deleteDelete any idea regardless of ownership
ideas:moderate_commentDelete any comment on ideas regardless of ownership (comment editing is author-only)
PermissionDescription
copyright:moderateApprove/dismiss community vote candidates into the global cross-account safe/blocked catalogue (approveReport/dismissReport + REST /v1/copyright/vote-candidates/{track_id}/approve·/dismiss). Admin-scope (platform operator) — seeded to system_admin, not assignable to any tenant role (ZAF-742).

Admin: User Roles

PermissionDescription
user-roles:readView user roles and their permissions
user-roles:createCreate new user roles
user-roles:editEdit user role name, description, permissions, and assignments
user-roles:deleteDelete user roles (is_system roles are protected server-side)

Admin: Crawler

Platform-operator control of the public stats crawler — a single global resource (one crawler, one global scope flip). Moved from account scope to admin scope in ZAF-725; enforced via require_admin_permission / AdminPermissionGuard and seeded to the system_admin role only.

PermissionDescription
crawler:scope-readRead the public stats crawler's scope mode (GET /v1/crawler/scope / crawlerScope)
crawler:scope-editSet the crawl scope mode, incl. the opt-in global flip (PUT /v1/crawler/scope / setCrawlerScope)
crawler:watchlist-readList the crawl watchlist (GET /v1/crawler/watchlist / crawlerWatchlist)
crawler:watchlist-createAdd a channel to the crawl watchlist (POST /v1/crawler/watchlist / addCrawlerWatchlistChannel)
crawler:watchlist-deleteRemove a channel from the crawl watchlist (DELETE /v1/crawler/watchlist/{platform}/{platform_channel_id} / removeCrawlerWatchlistChannel)

Actions are granular (the coarse :manage is disallowed); each scope change or watchlist mutation emits a system-scope audit event. The Admin app additionally gates entry on admin:access.

Admin: Shared with Account Scope

Seventeen permission strings are declared in both admin scope and account scope. They share the same string value but are enforced by different guards (require_admin_permission against the user's admin role vs require_permission against their account role), so holding one does not grant the other:

PermissionsCategory
copyright:read, copyright:edit, copyright:deleteCopyright
obs:read, obs:editOBS
bot-modules:read, bot-modules:editBot Modules
bot-commands:read, bot-commands:create, bot-commands:edit, bot-commands:deleteBot Commands
bot-connections:read, bot-connections:create, bot-connections:deleteBot Connections
se-tokens:read, se-tokens:deleteStreamElements
audit-log:readAudit Log

User-Scoped Permissions

User-scoped permissions are global — they are not tied to a specific account. They control access to platform-wide features that exist outside the account context, such as the Ideas Hub. User-scoped permissions are assigned via user roles (user_roles / user_role_permissions), not account roles. Enforcement uses auth.require_user_permission() on the backend.

Ideas Hub

PermissionDescription
ideas:readRead ideas
ideas:createCreate new ideas
ideas:editEdit own ideas
ideas:deleteDelete own ideas
ideas:voteVote on ideas
ideas:comment_readRead comments on ideas
ideas:comment_createCreate comments on ideas
ideas:comment_editEdit own comments
ideas:comment_deleteDelete own comments
ideas:comment_voteVote on comments and replies

Default User Roles

Three system user roles are seeded by default:

Member

Assigned to all users automatically. Grants full Ideas Hub participation.

CategoryPermissions
Ideasideas:read, ideas:create, ideas:edit, ideas:delete, ideas:vote
Commentsideas:comment_read, ideas:comment_create, ideas:comment_edit, ideas:comment_delete, ideas:comment_vote

Restricted

Limited to read-only access.

CategoryPermissions
Ideasideas:read
Commentsideas:comment_read

Moderator

Full user permissions plus admin-level moderation capabilities. The five ideas:moderate_* permissions are admin-scoped — see Admin: Ideas Moderation above.

CategoryPermissions
Ideasideas:read, ideas:create, ideas:edit, ideas:delete, ideas:vote
Commentsideas:comment_read, ideas:comment_create, ideas:comment_edit, ideas:comment_delete, ideas:comment_vote
Moderation (admin-scoped)ideas:moderate_read, ideas:moderate_status, ideas:moderate_edit, ideas:moderate_delete, ideas:moderate_comment

Team-Scoped Permissions (Developer Teams)

Team-scoped permissions control what each member can do within a developer team. They are separate from both account-scope and admin-scope permissions and are defined in crates/lo-auth/src/rbac.rs::team. Enforcement uses require_team_permission() in REST handlers and an equivalent helper in GraphQL resolvers. Permissions are cached in Redis per (team_id, user_id) pair.

Extension Development

PermissionDescription
team-extensions:createCreate extensions within the team
team-extensions:editEdit team extensions (metadata, code, assets)
team-extensions:deleteDelete team extensions
team-extensions:publishSubmit extensions for review and release
team-extensions:analyticsView extension analytics (installs, usage, ratings)
team-versions:createCreate new extension versions
team-versions:editEdit extension versions

Secrets

PermissionDescription
team-secrets:readRead team secrets (API keys, webhooks)
team-secrets:editEdit team secrets

Testers

PermissionDescription
team-testers:readRead the list of extension testers
team-testers:inviteInvite extension testers
team-testers:removeRemove extension testers

Team Members

PermissionDescription
team-members:readRead team member list
team-members:inviteInvite new team members
team-members:editEdit team member roles
team-members:removeRemove team members

Team Settings

PermissionDescription
team-settings:readRead team settings
team-settings:editEdit team settings

Payouts

PermissionDescription
team-payouts:readRead team payout information
team-payouts:editEdit team payout configuration

Default Team Roles

Three roles are seeded for every new developer team:

Owner (team-owner)

System role (cannot be deleted). All 20 team permissions.

Admin (team-admin)

Manage extensions and team members. All permissions except team-settings:edit, team-payouts:edit, and team-members:remove.

Member (team-member)

View and develop extensions. Permissions: team-extensions:create, team-extensions:edit, team-extensions:analytics, team-versions:create, team-members:read, team-secrets:read, team-settings:read.

Popout Tokens

Popout tokens inherit specific permissions when created. A popout token can only have permissions that the creating user's role grants. For example, a Moderator cannot create a popout token with settings:edit.

Overlay Tokens

Overlay tokens (lm_overlay_*) have no RBAC permissions. They cannot access any REST or GraphQL endpoint. Their sole capability is subscribing to the overlay:{key} WebSocket channel where the token's bound overlay_id matches the resolved overlay key.

  • has_permission(_) always returns false
  • Cannot broadcast to any channel
  • Cannot subscribe to any channel other than the one matching their bound overlay
  • Rate-limited at 600 requests/min (same tier as Popout tokens)

Shared Overlay Tokens

Shared overlay tokens (lm_share_*) provide temporary, time-limited access to a specific overlay. They are designed for sharing overlays with collaborators or backup streaming setups without granting permanent account access.

  • Prefix: lm_share_ (9 characters)
  • Body: 32 random bytes, hex-encoded (64 characters)
  • Total length: 73 characters
  • Transport: ?token=lm_share_… query parameter or Authorization: Bearer lm_share_… header
  • Rate-limited at 600 requests/min (same tier as Popout and Overlay tokens)
  • has_permission(_) always returns false
  • Cannot access REST or GraphQL endpoints
  • Can only subscribe to the overlay:{key} WebSocket channel matching the token's bound overlay
  • Server checks expiry every heartbeat tick (5s) — disconnects with TOKEN_EXPIRED when elapsed
  • Server checks DB revocation every 30 seconds — disconnects with TOKEN_REVOKED if revoked

Token Types

TypePrefixLengthPurpose
System Keylm_sys_71Internal service-to-service auth
User API Keylm_usr_71External API access
JWTlm_ + eyJ...variableSession-based auth
Popout Tokenlm_pop_71Overlay/popout access with a scoped permission subset
Overlay Tokenlm_overlay_75Per-overlay browser source access
Shared Overlay Tokenlm_share_73Temporary shared overlay link
Extension Tokenlm_ext_71Extension iframe, scoped to one install
Widget Tokenlm_widget_74Per-widget-instance browser source access

Popout tokens accept an optional expires_at; absent or null means the token never expires. See Authentication for transports and rate limits.

Extension Permissions

Extension tokens (lm_ext_*) have no RBAC permissions (has_permission() always returns false). Instead, extensions declare required permissions in lumio.config.json and are granted only those capabilities at install time. The Lumio API validates each action call against the extension's declared permission set.

Available Extension Permissions

The manifest validator accepts exactly these strings in lumio.config.json permissions — anything else fails validation at upload:

PermissionDescriptionReview level
events:readRead events from the Lumio event busStandard
events:emitEmit custom eventsStandard
chat:readRead chat messagesStandard
chat:sendSend chat messagesStandard
chat:deleteDelete chat messagesEnhanced
chat:banBan and unban users, timeout usersEnhanced
obs:set_sceneSwitch the active OBS sceneStandard
obs:set_source_visibleToggle OBS source visibilityStandard
obs:start_streamStart the OBS streamStandard
obs:stop_streamStop the OBS streamStandard
overlay:update_layerUpdate overlay layer propertiesStandard

Enhanced review: Extensions requesting chat:ban or chat:delete receive additional scrutiny during the approval process. Reviewers verify that the extension implements appropriate safeguards (e.g., confirmation prompts, configurable thresholds, exempt role support) and that the moderation logic does not create excessive false positives. The chat:ban permission grants ban, unban, and timeout capabilities through a single declaration.

Action-to-declaration mapping

At call time, each action resolves to the manifest permission the install must have declared; an undeclared permission is rejected before the action runs:

ActionRequired declaration
chat:send, chat:deletechat:read
events:emitevents:read
overlay:update_layeroverlays:edit
obs:set_scene, obs:set_source_visible, obs:start_stream, obs:stop_streamobs:control

obs:control and overlays:edit are the strings this mapping checks for; they are not among the values the manifest validator accepts, so the OBS and overlay-layer actions cannot currently be authorised through a validated manifest.

API Keys

A User API key carries an explicit permission list stored on the key row, not a live reference to the creator's role — the scope is fixed at creation and can never exceed what the creator held then. GET /v1/tokens/me (GraphQL myPermissions) reports that effective scope verbatim, never a wildcard. Keys may carry an expires_at; an expired key resolves to Anonymous rather than erroring. Rate limits differ by auth type — see Authentication.