privilege.query

Type: object

Call parameters

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

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extra

Extra

Type: object Default: {}

order_by

Order By

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

Each item of this array must be:

Type: string

select

Select

Type: array Default: []
No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

count

Count

Type: boolean Default: false

get

Get

Type: boolean Default: false

offset

Offset

Type: integer Default: 0

limit

Limit

Type: integer Default: 0

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Return value

Result

Any of

• Option 1
• PrivilegeQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

PrivilegeQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

builtin_name

Builtin Name

Any of

• Option 1
• Option 2

Type: string

Type: null

name

Name

Type: string

Must be at least 1 characters long

local_groups

Local Groups

Type: array
No Additional Items

Each item of this array must be:

Any of

• GroupEntry
• UnmappedGroupEntry

GroupEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

gid Required

Gid

Type: integer

name Required

Name

Type: string

Must be at least 1 characters long

builtin Required

Builtin

Type: boolean

sudo_commands

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

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

Smb

Type: boolean Default: true

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

userns_idmap

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

• Option 1
• Option 2
• Option 3

Type: const

Must be one of:

• "DIRECT"

Specific value: "DIRECT"

Type: integer

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

Type: null

group Required

Group

Type: string

Must be at least 1 characters long

id_type_both Required

Id Type Both

Type: boolean

local Required

Local

Type: boolean

sid Required

Sid

Any of

• Option 1
• Option 2

Type: string

Type: null

roles Required

Roles

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

users

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 Required

Gid

Any of

• Option 1
• Option 2

Type: integer

Type: null

sid Required

Sid

Any of

• Option 1
• Option 2

Type: string

Type: null

group Required

Group

Type: null

ds_groups

Ds Groups

Type: array
No Additional Items

Each item of this array must be:

Any of

• GroupEntry
• UnmappedGroupEntry

GroupEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

gid Required

Gid

Type: integer

name Required

Name

Type: string

Must be at least 1 characters long

builtin Required

Builtin

Type: boolean

sudo_commands

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

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

Smb

Type: boolean Default: true

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

userns_idmap

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

• Option 1
• Option 2
• Option 3

Type: const

Must be one of:

• "DIRECT"

Specific value: "DIRECT"

Type: integer

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

Type: null

group Required

Group

Type: string

Must be at least 1 characters long

id_type_both Required

Id Type Both

Type: boolean

local Required

Local

Type: boolean

sid Required

Sid

Any of

• Option 1
• Option 2

Type: string

Type: null

roles Required

Roles

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

users

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 Required

Gid

Any of

• Option 1
• Option 2

Type: integer

Type: null

sid Required

Sid

Any of

• Option 1
• Option 2

Type: string

Type: null

group Required

Group

Type: null

roles

Roles

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

web_shell

Web Shell

Type: boolean

PrivilegeQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

builtin_name

Builtin Name

Any of

• Option 1
• Option 2

Type: string

Type: null

name

Name

Type: string

Must be at least 1 characters long

local_groups

Local Groups

Type: array
No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: object

Type: object

ds_groups

Ds Groups

Type: array
No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: object

Type: object

roles

Roles

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

web_shell

Web Shell

Type: boolean

Type: integer

Required roles: PRIVILEGE_READ