# privilege.query

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: filters

#### filters

Type: array Default: []
No Additional Items

##### Each item of this array must be:

Type: object

##### Parameter 2: options

#### options

Type: object
Default:
{ "relationships": true, "extend": null, "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }
No Additional Properties

##

#### Relationships

Type: boolean Default: true

##

#### Extend

Default: null

## Any of

Type: string
Type: null

##

#### Extend Context

Default: null

## Any of

Type: string
Type: null

##

#### Prefix

Default: null

## Any of

Type: string
Type: null

##

#### Extra

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).

No Additional Items

##### Each item of this array must be:

Type: string
Example:

    [
        "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.

No Additional Items

##### Each item of this array must be:

## Any of

Type: string
Type: array
No Additional Items

##### Each item of this array must be:

Type: object
Example:

    [
        "username",
        "Authentication.status"
    ]

##

#### Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified `query-filters`.

##

#### Get

Type: boolean Default: false

Return 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: 0

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.

##

#### Limit

Type: integer Default: 0

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 Sql Filters

Type: boolean Default: false

##

#### Result

## Any of

Type: array of object
No Additional Items

##### Each item of this array must be:

#### PrivilegeQueryResultItem

Type: object
No Additional Properties

##

#### Id

Type: integer

##

#### Builtin Name

## Any of

Type: string
Type: null

##

#### Name

Type: string

Must be at least `1` characters long

##

#### Local Groups

Type: array
No Additional Items

##### Each item of this array must be:

## Any of

#### GroupEntry

Type: object
No Additional Properties

##

#### Id

Type: integer

##

#### Gid

Type: integer

##

#### Name

Type: string

Must be at least `1` characters long

##

#### Builtin

Type: boolean

##

#### Sudo Commands

Type: array of string Default: []
No Additional Items

##### Each item of this array must be:

Type: string

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:

Type: string

Must be at least `1` characters long

##

#### Smb

Type: boolean Default: true

Specifies whether the group should be mapped into an NT group.

##

#### Userns Idmap

Default: null

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.

## Any of

Type: const
Specific value: `"DIRECT"`
Type: integer

Value must be greater or equal to `1` and lesser or equal to `4294967294`

Type: null

##

#### Group

Type: string

Must be at least `1` characters long

##

#### Id Type Both

Type: boolean

##

#### Local

Type: boolean

##

#### Sid

## Any of

Type: string
Type: null

##

#### Roles

Type: array of string
No Additional Items

##### Each item of this array must be:

Type: string

##

#### Users

Type: array of integer Default: []

A list of user ids (`id` attribute from `user.query`).

No Additional Items

##### Each item of this array must be:

Type: integer

#### UnmappedGroupEntry

Type: object
No Additional Properties

##

#### Gid

## Any of

Type: integer
Type: null

##

#### Sid

## Any of

Type: string
Type: null

##

#### Group

Type: null

##

#### Ds Groups

Type: array
No Additional Items

##### Each item of this array must be:

## Any of

#### GroupEntry

Type: object
No Additional Properties

##

#### Id

Type: integer

##

#### Gid

Type: integer

##

#### Name

Type: string

Must be at least `1` characters long

##

#### Builtin

Type: boolean

##

#### Sudo Commands

Type: array of string Default: []
No Additional Items

##### Each item of this array must be:

Type: string

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:

Type: string

Must be at least `1` characters long

##

#### Smb

Type: boolean Default: true

Specifies whether the group should be mapped into an NT group.

##

#### Userns Idmap

Default: null

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.

## Any of

Type: const
Specific value: `"DIRECT"`
Type: integer

Value must be greater or equal to `1` and lesser or equal to `4294967294`

Type: null

##

#### Group

Type: string

Must be at least `1` characters long

##

#### Id Type Both

Type: boolean

##

#### Local

Type: boolean

##

#### Sid

## Any of

Type: string
Type: null

##

#### Roles

Type: array of string
No Additional Items

##### Each item of this array must be:

Type: string

##

#### Users

Type: array of integer Default: []

A list of user ids (`id` attribute from `user.query`).

No Additional Items

##### Each item of this array must be:

Type: integer

#### UnmappedGroupEntry

Type: object
No Additional Properties

##

#### Gid

## Any of

Type: integer
Type: null

##

#### Sid

## Any of

Type: string
Type: null

##

#### Group

Type: null

##

#### Roles

Type: array of string
No Additional Items

##### Each item of this array must be:

Type: string

##

#### Web Shell

Type: boolean

#### PrivilegeQueryResultItem

Type: object
No Additional Properties

##

#### Id

Type: integer

##

#### Builtin Name

## Any of

Type: string
Type: null

##

#### Name

Type: string

Must be at least `1` characters long

##

#### Local Groups

Type: array
No Additional Items

##### Each item of this array must be:

## Any of

Type: object
Type: object

##

#### Ds Groups

Type: array
No Additional Items

##### Each item of this array must be:

## Any of

Type: object
Type: object

##

#### Roles

Type: array of string
No Additional Items

##### Each item of this array must be:

Type: string

##

#### Web Shell

Type: boolean
Type: integer

Required roles: PRIVILEGE_READ