Skip to main content

User

idstring<uuid>required
usernamestringrequired
roleUserRolerequired

Admin (full UI), viewer (read-only UI), or share-only (SMB/NFS only, no UI login at all — the default for a new account). A share-only account can still sign in with this role on a session that predates a role change; every operation but the public ones refuses it, and login itself refuses a share-only account outright.

Possible values: [admin, viewer, share-only]

totpEnrolledbooleanrequired

Whether TOTP is confirmed and active on this account.

User
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "username": "string",
  "role": "admin",
  "totpEnrolled": true
}