List of filters for query results. See API documentation for "Query Methods" for more guidance.
No Additional Items[
[
"name",
"=",
"bob"
]
]
[
[
"OR",
[
[
[
"name",
"=",
"bob"
]
],
[
[
"name",
"=",
"larry"
]
]
]
]
]
Query options including pagination, ordering, and additional parameters.
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 authentication session.
Whether this is the current active session.
Whether this is an internal system session.
Origin information for the session (IP address, hostname, etc.).
Authentication method used for this session.
UNIX_SOCKET: Local Unix domain socket authenticationLOGIN_PASSWORD: Username and password authenticationLOGIN_TWOFACTOR: Two-factor authentication loginLOGIN_ONETIME_PASSWORD: One-time password authenticationAPI_KEY: API key authenticationTOKEN: Token-based authenticationTRUENAS_NODE: TrueNAS cluster node authenticationDetailed credential information specific to the authentication method.
Username of the authenticated user.
Unique identifier for the login.
Timestamp of when the user logged in.
Username of the authenticated user.
Unique identifier for the login.
Timestamp of when the user logged in.
API key information used for authentication.
No Additional PropertiesUnique identifier for the API key.
Human-readable name of the API key.
Parent credential information that generated this token.
No Additional PropertiesType of credentials used to generate this token.
Credential data used to authenticate the token request.
Username of the authenticated user.
Unique identifier for the login.
Timestamp of when the user logged in.
Username of the authenticated user.
Unique identifier for the login.
Timestamp of when the user logged in.
API key information used for authentication.
Parent credential information that generated this token.
Unique identifier for the login.
Username associated with the token. null if not user-specific.
Unique identifier for the login.
Username associated with the token. null if not user-specific.
Timestamp when the session was created.
Whether the session was established over a secure transport (HTTPS/WSS).
Unique identifier for the authentication session.
Whether this is the current active session.
Whether this is an internal system session.
Origin information for the session (IP address, hostname, etc.).
Authentication method used for this session.
UNIX_SOCKET: Local Unix domain socket authenticationLOGIN_PASSWORD: Username and password authenticationLOGIN_TWOFACTOR: Two-factor authentication loginLOGIN_ONETIME_PASSWORD: One-time password authenticationAPI_KEY: API key authenticationTOKEN: Token-based authenticationTRUENAS_NODE: TrueNAS cluster node authenticationDetailed credential information specific to the authentication method.
Timestamp when the session was created.
Whether the session was established over a secure transport (HTTPS/WSS).