group.get_instance¶
Returns instance matching id. If id is not found, Validation error is raised.
Please see query method documentation for options.
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerParameter 2: options
options
Type: object Default: {}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.
Relationships
Type: boolean Default: trueExtend
Default: nullExtend Fk
Type: array of string Default: []No Additional Items
Each item of this array must be:
Extend Context
Default: nullPrefix
Default: nullExtra
Type: object Default: {}Extra options are defined on a per-endpoint basis and are described in the documentation for the associated
query method.
Order By
Type: array of string Default: []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).
Each item of this array must be:
[
"size",
"-devname",
"nulls_first:-expiretime"
]
Select
Type: array Default: []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.
Each item of this array must be:
No Additional Items
Each item of this array must be:
[
"username",
"Authentication.status"
]
Count
Type: boolean Default: falseReturn a numeric value representing the number of items that match the specified query-filters.
Get
Type: boolean Default: falseReturn the JSON object of the first result matching the specified query-filters. The query fails
if there specified query-filters return no results.
Offset
Type: integer Default: 0This 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.
Limit
Type: integer Default: 0This 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 Sql Filters
Type: boolean Default: falseGroupEntry
Type: objectNo Additional Properties
Id
Type: integerGid
Type: integerName
Type: stringMust be at least 1 characters long
Builtin
Type: booleanSudo Commands
Type: array of string Default: []No Additional Items
Each item of this array must be:
Must be at least 1 characters long
Sudo Commands Nopasswd
Type: array of string Default: []No Additional Items
Each item of this array must be:
Must be at least 1 characters long
Smb
Type: boolean Default: trueUserns Idmap
Default: nullSpecifies 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 integer Default: []A list of user ids (id attribute from user.query).
Each item of this array must be:
Required roles: ACCOUNT_READ