user.query¶
Query users with query-filters and query-options.
If users provided by Active Directory or LDAP are not desired, then “local”, “=”, True should be added to filters.
No Additional Items
Tuple Validation
Parameter 1: filters
filters
Type: array Default: []No Additional Items
Each item of this array must be:
Parameter 2: options
options
Type: objectNo Additional Properties
Relationships
Type: boolean Default: trueExtend
Default: nullExtend Context
Default: nullPrefix
Default: nullExtra
Type: object Default: {}Order By
Type: array of string Default: []No Additional Items
Each item of this array must be:
Select
Type: array Default: []No Additional Items
Each item of this array must be:
No Additional Items
Each item of this array must be:
Count
Type: boolean Default: falseGet
Type: boolean Default: falseOffset
Type: integer Default: 0Limit
Type: integer Default: 0Force Sql Filters
Type: boolean Default: falseResult
No Additional Items
Each item of this array must be:
UserQueryResultItem
Type: objectNo Additional Properties
Id
Type: integerUid
Type: integerUsername
Must be at least 1 characters long
Unixhash
Smbhash
Home
Type: stringMust be at least 1 characters long
Shell
Type: stringAvailable choices can be retrieved with user.shell_choices.
Must be at least 1 characters long
Full Name
Type: stringBuiltin
Type: booleanSmb
Type: booleanUserns Idmap
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.
Must be one of:
- "DIRECT"
"DIRECT" Value must be greater or equal to 1 and lesser or equal to 4294967294
Group
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: booleanSsh Password Enabled
Type: booleanRequired if password_disabled is false.
Sshpubkey
Locked
Type: booleanSudo 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
Last Password Change
The date of the last password change for local user accounts.
Password Age
The age in days of the password for local user accounts.
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.
No Additional Items
Each item of this array must be:
Password Change Required
Type: booleanPassword change for local user account is required on next login.
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:
UserQueryResultItem
Type: objectNo Additional Properties
Id
Type: integerUid
Type: integerUsername
Must be at least 1 characters long
Unixhash
Smbhash
Home
Type: stringMust be at least 1 characters long
Shell
Type: stringAvailable choices can be retrieved with user.shell_choices.
Must be at least 1 characters long
Full Name
Type: stringBuiltin
Type: booleanSmb
Type: booleanUserns Idmap
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.
Must be one of:
- "DIRECT"
"DIRECT" Value must be greater or equal to 1 and lesser or equal to 4294967294
Group
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: booleanSsh Password Enabled
Type: booleanRequired if password_disabled is false.
Sshpubkey
Locked
Type: booleanSudo 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
Last Password Change
The date of the last password change for local user accounts.
Password Age
The age in days of the password for local user accounts.
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.
No Additional Items
Each item of this array must be:
Password Change Required
Type: booleanPassword change for local user account is required on next login.
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: ACCOUNT_READ