user.create¶
Create a new user.
Type: object
Type: array
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
Email
Default: null
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.
Type: integer
Value must be greater or equal to 0
and lesser or equal to 90000000
Type: null
Username
Type: string
Type: string
Must be at least 1
characters long
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: trueGroup
Default: nullRequired if group_create
is false
.
Type: integer
Type: null
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:
Type: integer
Password Disabled
Type: boolean Default: falseSsh Password Enabled
Type: boolean Default: falseRequired if password_disabled
is false.
Sshpubkey
Default: null Type: string
Type: null
Locked
Type: boolean Default: falseSudo Commands
Type: array of stringNo Additional Items
Each item of this array must be:
Type: string
Must be at least 1
characters long
Sudo Commands Nopasswd
Type: array of stringNo Additional Items
Each item of this array must be:
Type: string
Must be at least 1
characters long
Type: stringFormat: email
Type: null
Group Create
Type: boolean Default: falseHome Create
Type: boolean Default: falseHome Mode
Type: string Default: "700"Password
Default: null Type: string
Type: null
Result
Type: integerRequired roles: