user.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer
Parameter 2: options

options

Type: object Default: {}
No Additional Properties

Relationships

Type: boolean Default: true

Extend

Default: null

Type: string
Type: null

Extend Context

Default: null

Type: string
Type: null

Prefix

Default: null

Type: string
Type: null

Extra

Type: object Default: {}

Order By

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

Select

Type: array Default: []
No Additional Items
Each item of this array must be:

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

Count

Type: boolean Default: false

Get

Type: boolean Default: false

Offset

Type: integer Default: 0

Limit

Type: integer Default: 0

Force Sql Filters

Type: boolean Default: false

UserEntry

Type: object
No Additional Properties

Id

Type: integer

Uid

Type: integer

Username


Type: string
Type: string

Must be at least 1 characters long

Unixhash


Type: string
Type: null

Smbhash


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

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

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

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

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

Type: stringFormat: email
Type: null

Id Type Both

Type: boolean

Local

Type: boolean

Immutable

Type: boolean

Twofactor Auth Configured

Type: boolean

Sid


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


Required roles: ACCOUNT_READ