group.query¶
Query groups with query-filters and query-options.
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:
GroupQueryResultItem
Type: objectNo Additional Properties
Id
Type: integerGid
Type: integerName
Type: stringMust be at least 1 characters long
Builtin
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
Smb
Type: booleanSpecifies whether the group should be mapped into an NT group.
Userns Idmap
Species the subgid mapping for this group. If DIRECT then the GID will be
directly mapped to all containers. Alternatively, the target GID may be
explicitly specified. If None, then the GID will not be mapped.
NOTE: this field will be ignored for groups 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: stringMust be at least 1 characters long
Id Type Both
Type: booleanLocal
Type: booleanSid
Roles
Type: array of stringNo Additional Items
Each item of this array must be:
Users
Type: array of integerA list of user ids (id attribute from user.query).
Each item of this array must be:
GroupQueryResultItem
Type: objectNo Additional Properties
Id
Type: integerGid
Type: integerName
Type: stringMust be at least 1 characters long
Builtin
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
Smb
Type: booleanSpecifies whether the group should be mapped into an NT group.
Userns Idmap
Species the subgid mapping for this group. If DIRECT then the GID will be
directly mapped to all containers. Alternatively, the target GID may be
explicitly specified. If None, then the GID will not be mapped.
NOTE: this field will be ignored for groups 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: stringMust be at least 1 characters long
Id Type Both
Type: booleanLocal
Type: booleanSid
Roles
Type: array of stringNo Additional Items
Each item of this array must be:
Users
Type: array of integerA list of user ids (id attribute from user.query).
Each item of this array must be:
Required roles: ACCOUNT_READ