# 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.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: username

#### username

Type: string

##### Parameter 2: twofactor_options

#### twofactor_options

Type: object
No Additional Properties

##

#### Otp Digits

Type: integer

Represents number of allowed digits in the OTP

Value must be greater or equal to `6` and lesser or equal to `8`

##

#### Interval

Type: integer

Time duration in seconds specifying OTP expiration time from its creation time

Value must be greater or equal to `5`

##

#### UserRenew2faSecretResult

Type: object

UserRenew2faSecretResult return fields.

No Additional Properties

##

#### Id

Type: integer

##

#### Uid

Type: integer

##

#### Username

## Any of

Type: string
Type: string

Must be at least `1` characters long

##

#### Unixhash

## Any of

Type: string
Type: null

##

#### Smbhash

## Any of

Type: string
Type: null

##

#### 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: string

##

#### Builtin

Type: boolean

##

#### Smb

Type: boolean Default: true

##

#### Userns Idmap

Default: null

Specifies 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.

## Any of

Type: const
Specific value: `"DIRECT"`
Type: integer

Value must be greater or equal to `1` and lesser or equal to `4294967294`

Type: null

##

#### Group

Type: object

##

#### 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 Default: false

##

#### Ssh Password Enabled

Type: boolean Default: false

Required if `password_disabled` is false.

##

#### Sshpubkey

Default: null

## Any of

Type: string
Type: null

##

#### Locked

Type: boolean Default: false

##

#### 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

Default: null

## Any of

Type: string Format: email
Type: null

##

#### Id Type Both

Type: boolean

##

#### Local

Type: boolean

##

#### Immutable

Type: boolean

##

#### Twofactor Auth Configured

Type: boolean

##

#### Sid

## Any of

Type: string
Type: null

##

#### Roles

Type: array of string
No Additional Items

##### Each item of this array must be:

Type: string

##

#### Api Keys

Type: array of integer
No Additional Items

##### Each item of this array must be:

Type: integer

##

#### UserTwofactorConfigEntry

Type: object
No Additional Properties

##

#### Provisioning Uri

## Any of

Type: string
Type: null

##

#### Secret Configured

Type: boolean

##

#### Interval

Type: integer

##

#### Otp Digits

Type: integer

Required roles: