Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.
No Additional PropertiesExtra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.
An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).
[
"size",
"-devname",
"nulls_first:-expiretime"
]
An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.
[
"username",
"Authentication.status"
]
Return a numeric value representing the number of items that match the specified query-filters.
Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.
This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.
WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
Force use of SQL for result filtering to reduce response time. May not work for all methods.
Unique identifier for the privilege.
Name of the built-in privilege if this is a system privilege. null for custom privileges.
Display name of the privilege.
Must be at least 1 characters long
Array of local groups assigned to this privilege.
No Additional ItemsThis is the API identifier for the group. Use this ID for group.update and group.delete API calls. This ID also appears in the groups array for each user entry in user.query results.
NOTE: For groups from a directory service, the id is calculated by adding 100000000 to the gid. This ensures consistent API results. You cannot change directory service accounts through TrueNAS.
A non-negative integer used to identify a group. TrueNAS uses this value for permission checks and many other system purposes.
A string used to identify a group.
Must be at least 1 characters long
If True, the group is an internal system account for the TrueNAS server. Typically, one should create dedicated groups for access to the TrueNAS server webui and shares.
A list of commands that group members may execute with elevated privileges. User is prompted for password when executing any command from the list.
No Additional ItemsMust be at least 1 characters long
A list of commands that group members may execute with elevated privileges. User is not prompted for password when executing any command from the list.
No Additional ItemsMust be at least 1 characters long
If set to True, the group can be used for SMB share ACL entries. The group is mapped to an NT group account on the TrueNAS SMB server and has a sid value.
Specifies 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 null, then the GID will not be mapped.
NOTE: This field will be ignored for groups that have been assigned TrueNAS roles.
"DIRECT"
Value must be greater or equal to 1 and lesser or equal to 4294967294
A string used to identify a group. Identical to the name key.
Must be at least 1 characters long
If True, the group is local to the TrueNAS server. If False, the group is provided by a directory service.
The Security Identifier (SID) of the user if the account an smb account. The SMB server uses this value to check share access and for other purposes.
List of roles assigned to this groups. Roles control administrative access to TrueNAS through the web UI and API. You can change group roles by using privilege.create, privilege.update, and privilege.delete.
A list a API user identifiers for local users who are members of this group. These IDs match the id field from user.query.
NOTE: This field is empty for groups that come from directory services (local is False).
This is a read-only field showing if the group entry can be changed. If True, the group is immutable and cannot be changed. If False, the group can be changed.
Group ID if this is a local group that couldn't be mapped. null for directory service groups.
Security identifier if this is a directory service group that couldn't be mapped. null for local groups.
Always null for unmapped groups.
Array of directory service groups assigned to this privilege.
No Additional ItemsThis is the API identifier for the group. Use this ID for group.update and group.delete API calls. This ID also appears in the groups array for each user entry in user.query results.
NOTE: For groups from a directory service, the id is calculated by adding 100000000 to the gid. This ensures consistent API results. You cannot change directory service accounts through TrueNAS.
A non-negative integer used to identify a group. TrueNAS uses this value for permission checks and many other system purposes.
A string used to identify a group.
Must be at least 1 characters long
If True, the group is an internal system account for the TrueNAS server. Typically, one should create dedicated groups for access to the TrueNAS server webui and shares.
A list of commands that group members may execute with elevated privileges. User is prompted for password when executing any command from the list.
No Additional ItemsMust be at least 1 characters long
A list of commands that group members may execute with elevated privileges. User is not prompted for password when executing any command from the list.
No Additional ItemsMust be at least 1 characters long
If set to True, the group can be used for SMB share ACL entries. The group is mapped to an NT group account on the TrueNAS SMB server and has a sid value.
Specifies 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 null, then the GID will not be mapped.
NOTE: This field will be ignored for groups that have been assigned TrueNAS roles.
"DIRECT"
Value must be greater or equal to 1 and lesser or equal to 4294967294
A string used to identify a group. Identical to the name key.
Must be at least 1 characters long
If True, the group is local to the TrueNAS server. If False, the group is provided by a directory service.
The Security Identifier (SID) of the user if the account an smb account. The SMB server uses this value to check share access and for other purposes.
List of roles assigned to this groups. Roles control administrative access to TrueNAS through the web UI and API. You can change group roles by using privilege.create, privilege.update, and privilege.delete.
A list a API user identifiers for local users who are members of this group. These IDs match the id field from user.query.
NOTE: This field is empty for groups that come from directory services (local is False).
This is a read-only field showing if the group entry can be changed. If True, the group is immutable and cannot be changed. If False, the group can be changed.
Group ID if this is a local group that couldn't be mapped. null for directory service groups.
Security identifier if this is a directory service group that couldn't be mapped. null for local groups.
Always null for unmapped groups.
Array of role names included in this privilege.
No Additional ItemsWhether this privilege grants access to the web shell.