privilege.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

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

No Additional Properties

extra

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

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

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

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

Example:

[
    "username",
    "Authentication.status"
]

count

Count

Type: boolean Default: false

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

get

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

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

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

Force Sql Filters

Type: boolean Default: false

Return value

PrivilegeEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

builtin_name Required

Builtin Name

Any of

• Option 1
• Option 2

Type: string

Type: null

name Required

Name

Type: string

Must be at least 1 characters long

local_groups Required

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

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

gid Required

Gid

Type: integer

A non-negative integer used to identify a group. TrueNAS uses this value for permission checks and many other system purposes.

name Required

Name

Type: string

A string used to identify a group.

Must be at least 1 characters long

builtin Required

Builtin

Type: boolean

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.

sudo_commands

Sudo Commands

Type: array of string Default: []

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 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: []

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 Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

smb

Smb

Type: boolean Default: true

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.

userns_idmap

Userns Idmap

Default: null

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.

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

A string used to identify a group. Identical to the name key.

Must be at least 1 characters long

local Required

Local

Type: boolean

If True, the group is local to the TrueNAS server. If False, the group is provided by a directory service.

sid Required

Sid

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.

Any of

• Option 1
• Option 2

Type: string

Type: null

roles Required

Roles

Type: array of string

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.

No Additional Items

Each item of this array must be:

Type: string

users

Users

Type: array of integer Default: []

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

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 Required

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

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

gid Required

Gid

Type: integer

A non-negative integer used to identify a group. TrueNAS uses this value for permission checks and many other system purposes.

name Required

Name

Type: string

A string used to identify a group.

Must be at least 1 characters long

builtin Required

Builtin

Type: boolean

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.

sudo_commands

Sudo Commands

Type: array of string Default: []

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 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: []

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 Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

smb

Smb

Type: boolean Default: true

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.

userns_idmap

Userns Idmap

Default: null

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.

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

A string used to identify a group. Identical to the name key.

Must be at least 1 characters long

local Required

Local

Type: boolean

If True, the group is local to the TrueNAS server. If False, the group is provided by a directory service.

sid Required

Sid

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.

Any of

• Option 1
• Option 2

Type: string

Type: null

roles Required

Roles

Type: array of string

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.

No Additional Items

Each item of this array must be:

Type: string

users

Users

Type: array of integer Default: []

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

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 Default: []
No Additional Items

Each item of this array must be:

Type: string

web_shell Required

Web Shell

Type: boolean

Required roles: PRIVILEGE_READ