Skip to content

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.

ConceptValuesImpact
Global roleroot, admin, userPlatform administration capability
Effective stateactive, bannedSign-in, room creation, and room joining
Preferences2FA, notificationsUser-level settings, not YAML configuration
Auth methodspassword, OPAQUE, passkey, email, OAuth2Sign-in and recovery options
  • 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.
Terminal window
synctv user list
synctv user get alice
synctv user create alice --email alice@example.com
synctv user ban alice --reason "abuse"
synctv user unban alice
synctv user set-role alice admin
synctv user preferences get alice
ScenarioPrefer
AbuseUse ban, keep the reason, avoid deleting audit context
Account recoveryVerify identity and bound methods before changing password, email, or 2FA
Promote administratorUse a root account and record the reason
Change 2FA preferenceConfirm at least two local verification methods remain
Delete accountEvaluate room, media, review, notification, and audit impact first

Authentication details are in Authentication and Security Model. User-facing behavior is in Sign In and Account Security.