user.query

Sent on user changes.

Type: object

ADDED

UserAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

UserEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

uid Required

Uid

Type: integer

username Required

Username

Any of

• Option 1
• Option 2

Type: string

Type: string

Must be at least 1 characters long

unixhash Required

Unixhash

Any of

• Option 1
• Option 2

Type: string

Type: null

smbhash Required

Smbhash

Any of

• Option 1
• Option 2

Type: string

Type: null

home

Home

Type: string Default: "/var/empty"

Must be at least 1 characters long

shell

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 Required

Full Name

Type: string

builtin Required

Builtin

Type: boolean

smb

Smb

Type: boolean Default: true

userns_idmap

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

• Option 1
• Option 2
• Option 3

Type: const

Must be one of:

• "DIRECT"

Specific value: "DIRECT"

Type: integer

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

Type: null

group Required

Group

Type: object

groups

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

Password Disabled

Type: boolean Default: false

ssh_password_enabled

Ssh Password Enabled

Type: boolean Default: false

Required if password_disabled is false.

sshpubkey

Sshpubkey

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

locked

Locked

Type: boolean Default: false

sudo_commands

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

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

Email

Default: null

Any of

• Option 1
• Option 2

Type: stringFormat: email

Type: null

id_type_both Required

Id Type Both

Type: boolean

local Required

Local

Type: boolean

immutable Required

Immutable

Type: boolean

twofactor_auth_configured Required

Twofactor Auth Configured

Type: boolean

sid Required

Sid

Any of

• Option 1
• Option 2

Type: string

Type: null

last_password_change Required

Last Password Change

The date of the last password change for local user accounts.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

password_age Required

Password Age

The age in days of the password for local user accounts.

Any of

• Option 1
• Option 2

Type: integer

Type: null

password_history Required

Password History

This contains hashes of the ten most recent passwords used by local user accounts, and is
for enforcing password history requirements as defined in system.security.

Any of

• Option 1
• Option 2

Type: array
No Additional Items

Each item of this array must be:

Type: object

Type: null

password_change_required Required

Password Change Required

Type: boolean

Password change for local user account is required on next login.

roles Required

Roles

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

api_keys Required

Api Keys

Type: array of integer
No Additional Items

Each item of this array must be:

Type: integer

CHANGED

UserChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

UserEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

uid Required

Uid

Type: integer

username Required

Username

Any of

• Option 1
• Option 2

Type: string

Type: string

Must be at least 1 characters long

unixhash Required

Unixhash

Any of

• Option 1
• Option 2

Type: string

Type: null

smbhash Required

Smbhash

Any of

• Option 1
• Option 2

Type: string

Type: null

home

Home

Type: string Default: "/var/empty"

Must be at least 1 characters long

shell

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 Required

Full Name

Type: string

builtin Required

Builtin

Type: boolean

smb

Smb

Type: boolean Default: true

userns_idmap

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

• Option 1
• Option 2
• Option 3

Type: const

Must be one of:

• "DIRECT"

Specific value: "DIRECT"

Type: integer

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

Type: null

group Required

Group

Type: object

groups

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

Password Disabled

Type: boolean Default: false

ssh_password_enabled

Ssh Password Enabled

Type: boolean Default: false

Required if password_disabled is false.

sshpubkey

Sshpubkey

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

locked

Locked

Type: boolean Default: false

sudo_commands

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

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

Email

Default: null

Any of

• Option 1
• Option 2

Type: stringFormat: email

Type: null

id_type_both Required

Id Type Both

Type: boolean

local Required

Local

Type: boolean

immutable Required

Immutable

Type: boolean

twofactor_auth_configured Required

Twofactor Auth Configured

Type: boolean

sid Required

Sid

Any of

• Option 1
• Option 2

Type: string

Type: null

last_password_change Required

Last Password Change

The date of the last password change for local user accounts.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

password_age Required

Password Age

The age in days of the password for local user accounts.

Any of

• Option 1
• Option 2

Type: integer

Type: null

password_history Required

Password History

This contains hashes of the ten most recent passwords used by local user accounts, and is
for enforcing password history requirements as defined in system.security.

Any of

• Option 1
• Option 2

Type: array
No Additional Items

Each item of this array must be:

Type: object

Type: null

password_change_required Required

Password Change Required

Type: boolean

Password change for local user account is required on next login.

roles Required

Roles

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

api_keys Required

Api Keys

Type: array of integer
No Additional Items

Each item of this array must be:

Type: integer

REMOVED

UserRemovedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

Required roles: ACCOUNT_READ