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: booleanGroup
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
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: booleanGroup
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
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: