user.update¶
Update attributes of an existing user.
Type: object
Type: array
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
Email
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerParameter 2: user_update
user_update
Type: objectNo Additional Properties
Username
Type: string
Type: string
Must be at least 1
characters long
Home
Type: stringMust be at least 1
characters long
Shell
Type: stringAvailable 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: booleanGroup
Required 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: booleanSsh Password Enabled
Type: booleanRequired if password_disabled
is false.
Sshpubkey
Type: string
Type: null
Locked
Type: booleanSudo 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
Home Create
Type: booleanHome Mode
Type: stringPassword
Type: string
Type: null
Result
Type: integerRequired roles: