Table Of Contents

Previous topic

user.unset_2fa_secret

Next topic

user.verify_twofactor_token

user.update

Update attributes of an existing user.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer
Parameter 2: user_update

user_update

Type: object
No Additional Properties

Username


Type: string
Type: string

Must be at least 1 characters long

Home

Type: string

Must be at least 1 characters long

Shell

Type: string

Available choices can be retrieved with user.shell_choices.

Must be at least 1 characters long

Full Name

Type: string

Must be at least 1 characters long

Smb

Type: boolean

Group


Required if group_create is false.

Type: integer
Type: null

Groups

Type: array of integer

Specifies whether the user should be allowed access to SMB shares. User will also automatically be added to
the builtin_users group.

No Additional Items
Each item of this array must be:
Type: integer

Password Disabled

Type: boolean

Ssh Password Enabled

Type: boolean

Required if password_disabled is false.

Sshpubkey


Type: string
Type: null

Locked

Type: boolean

Sudo Commands

Type: array of string
No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Sudo Commands Nopasswd

Type: array of string
No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Email


Type: stringFormat: email
Type: null

Home Create

Type: boolean

Home Mode

Type: string

Password


Type: string
Type: null

Result

Type: integer


Required roles: