user.create¶
Create a new user.
No Additional Items
Tuple Validation
Parameter 1: user_create
user_create
Type: objectNo Additional Properties
Uid
Default: nullUNIX UID. If not provided, it is automatically filled with the next one available.
Value must be greater or equal to 0 and lesser or equal to 90000000
Username
Type: stringString 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.
Home
Type: string Default: "/var/empty"Must be at least 1 characters long
Shell
Type: string Default: "/usr/bin/zsh"Available choices can be retrieved with user.shell_choices.
Must be at least 1 characters long
Full Name
Type: stringMust be at least 1 characters long
Smb
Type: boolean Default: trueUserns Idmap
Default: nullSpecifies 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.
Must be one of:
- "DIRECT"
"DIRECT" Value must be greater or equal to 1 and lesser or equal to 4294967294
Group
Default: nullRequired if group_create is false.
Groups
Type: array of integerSpecifies whether the user should be allowed access to SMB shares. User will also automatically be added to
the builtin_users group.
Each item of this array must be:
Password Disabled
Type: boolean Default: falseSsh Password Enabled
Type: boolean Default: falseRequired if password_disabled is false.
Sshpubkey
Default: nullLocked
Type: boolean Default: falseSudo Commands
Type: array of stringNo Additional Items
Each item of this array must be:
Must be at least 1 characters long
Sudo Commands Nopasswd
Type: array of stringNo Additional Items
Each item of this array must be:
Must be at least 1 characters long
Group Create
Type: boolean Default: falseHome Create
Type: boolean Default: falseHome Mode
Type: string Default: "700"Password
Default: nullMust be at least 1 characters long
Random Password
Type: boolean Default: falseGenerate a random 20 character password for the user
UserCreateUpdateResult
Type: objectNo Additional Properties
Id
Type: integerUid
Type: integerUsername
Must be at least 1 characters long
Unixhash
Smbhash
Home
Type: string Default: "/var/empty"Must be at least 1 characters long
Shell
Type: string Default: "/usr/bin/zsh"Available choices can be retrieved with user.shell_choices.
Must be at least 1 characters long
Full Name
Type: stringBuiltin
Type: booleanSmb
Type: boolean Default: trueUserns Idmap
Default: nullSpecifies 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.
Must be one of:
- "DIRECT"
"DIRECT" Value must be greater or equal to 1 and lesser or equal to 4294967294
Group
Type: objectGroups
Type: array of integerSpecifies whether the user should be allowed access to SMB shares. User will also automatically be added to
the builtin_users group.
Each item of this array must be:
Password Disabled
Type: boolean Default: falseSsh Password Enabled
Type: boolean Default: falseRequired if password_disabled is false.
Sshpubkey
Default: nullLocked
Type: boolean Default: falseSudo Commands
Type: array of stringNo Additional Items
Each item of this array must be:
Must be at least 1 characters long
Sudo Commands Nopasswd
Type: array of stringNo Additional Items
Each item of this array must be:
Must be at least 1 characters long
Id Type Both
Type: booleanLocal
Type: booleanImmutable
Type: booleanTwofactor Auth Configured
Type: booleanSid
Last Password Change
The date of the last password change for local user accounts.
Password Age
The age in days of the password for local user accounts.
Password History
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.
No Additional Items
Each item of this array must be:
Password Change Required
Type: booleanPassword change for local user account is required on next login.
Roles
Type: array of stringNo Additional Items
Each item of this array must be:
Api Keys
Type: array of integerNo Additional Items
Each item of this array must be:
Password
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
Required roles: ACCOUNT_WRITE