Skip to content
SyncTVSyncTV Docs

User Management

Users have global roles, effective state, and security preferences. When handling user issues, first decide whether the cause is account state, authentication method, global role, or room permissions. The Resource Lifecycle page defines deletion, recovery, and resource cascades.

User State

Section titled “User State”
Concept Values Impact
Global role root, admin, user Platform administration capability
Effective state active, banned Sign-in, room creation, and room joining
Preferences 2FA, notifications User-level settings, not YAML configuration
Auth methods password, OPAQUE, passkey, TOTP, recovery codes, email, OAuth2 Sign-in and recovery options

Role Boundaries

Section titled “Role Boundaries”
  • root can manage all users and administrators.
  • admin can manage normal users but cannot manage root or equally privileged administrators.
  • user can use rooms and media features according to business permissions.

Common Commands

Section titled “Common Commands”
终端窗口
synctv user list
synctv user get alice
synctv user create alice --email [email protected]
synctv user list --include-deleted
synctv user ban alice --reason "abuse"
synctv user unban alice
synctv user bans list --active
synctv user restore alice
synctv user restore alice --ignore-identity-conflicts
synctv user set-role alice admin
synctv user preferences get alice

Rules

Section titled “Rules”
Scenario Prefer
Abuse Use ban, keep the reason, avoid deleting audit context
Deleted-account recovery Run user restore during retention and resolve identity conflicts first
Account access recovery Verify identity and bound methods before changing password, email, or 2FA
Promote administrator Use a root account and record the reason
Change 2FA preference Confirm at least two local verification methods remain
Delete account Evaluate room, media, review, notification, and audit impact first

See Authentication and Security for 2FA, OAuth2, WebAuthn, and token boundaries.