Skip to main content

UserSummary

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.

hasCredentialbooleanrequired

Whether a Samba/password credential (SMB access) is currently provisioned for this account. Set the first time setUserPassword succeeds for it; there is no separate action that clears it short of deleting the account.

lastLogin(string | null)<date-time>nullablerequired

When this account last completed sign-in, tracked at authentication time — never derived from whether a session is still live. Null when it has never signed in.

createdAtstring<date-time>required
UserSummary
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "username": "string",
  "role": "admin",
  "totpEnrolled": true,
  "hasCredential": true,
  "lastLogin": "2024-07-29T15:51:28.071Z",
  "createdAt": "2024-07-29T15:51:28.071Z"
}