user.renew_2fa_secret¶
Renew username user’s two-factor authentication secret.
NOTE: This username must match the authenticated username unless authenticated credentials have FULL_ADMIN role.
No Additional Items
Tuple Validation
Parameter 1: username
username
Type: stringParameter 2: twofactor_options
twofactor_options
Type: objectNo Additional Properties
Otp Digits
Type: integerRepresents number of allowed digits in the OTP
Value must be greater or equal to 6
and lesser or equal to 8
Interval
Type: integerTime duration in seconds specifying OTP expiration time from its creation time
Value must be greater or equal to 5
UserEntry
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: trueGroup
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
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:
Required roles: