String used to uniquely identify the user on the server. In order to be portable across
systems, local user names must be composed of characters from the POSIX portable filename
character set (IEEE Std 1003.1-2024 section 3.265). This means alphanumeric characters,
hyphens, underscores, and periods. Usernames also may not begin with a hyphen or a period.
Must be at least 1 characters long
Available choices can be retrieved with user.shell_choices.
Must be at least 1 characters long
Must be at least 1 characters long
Specifies the subuid mapping for this user. If DIRECT then the UID will be
directly mapped to all containers. Alternatively, the target UID may be
explicitly specified. If None, then the UID will not be mapped.
NOTE: this field will be ignored for users that have been assigned
TrueNAS roles.
Value must be greater or equal to 1 and lesser or equal to 4294967294
Required if group_create is false.
Specifies whether the user should be allowed access to SMB shares. User will also automatically be added to
the builtin_users group.
Required if password_disabled is false.
Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
Generate a random 20 character password for the user
Must be at least 1 characters long
Must be at least 1 characters long
Available choices can be retrieved with user.shell_choices.
Must be at least 1 characters long
Specifies the subuid mapping for this user. If DIRECT then the UID will be
directly mapped to all containers. Alternatively, the target UID may be
explicitly specified. If None, then the UID will not be mapped.
NOTE: this field will be ignored for users that have been assigned
TrueNAS roles.
Value must be greater or equal to 1 and lesser or equal to 4294967294
Specifies whether the user should be allowed access to SMB shares. User will also automatically be added to
the builtin_users group.
Required if password_disabled is false.
Must be at least 1 characters long
Must be at least 1 characters long
The date of the last password change for local user accounts.
The age in days of the password for local user accounts.
This contains hashes of the ten most recent passwords used by local user accounts, and is
for enforcing password history requirements as defined in system.security.
Password change for local user account is required on next login.
Password if it was specified in create or update payload. If random_password
was specified then this will be a 20 character random string.
Must be at least 1 characters long