Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: privilege_create

privilege_create

Type: object
No Additional Properties

Name

Type: string

Must be at least 1 characters long

Local Groups

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

Each item of this array must be:

Type: integer

Ds Groups

Type: array Default: []
No Additional Items

Each item of this array must be:

Type: integer

Type: string

Roles

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

Each item of this array must be:

Type: string

Web Shell

Type: boolean

PrivilegeEntry

Type: object
No Additional Properties

Id

Type: integer

Builtin Name

Any of

Option 1
Option 2

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
UnmappedGroupEntry

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

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

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

Type: string

Must be at least 1 characters long

Id Type Both

Type: boolean

Local

Type: boolean

Sid

Any of

Option 1
Option 2

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

Option 1
Option 2

Type: integer

Type: null

Sid

Any of

Option 1
Option 2

Type: string

Type: null

Group

Type: null

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

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

Userns Idmap

Default: null

NOTE: this field will be ignored for groups that have been assigned
TrueNAS roles.

Any of

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

Type: string

Must be at least 1 characters long

Id Type Both

Type: boolean

Local

Type: boolean

Sid

Any of

Option 1
Option 2

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

Option 1
Option 2

Type: integer

Type: null

Sid

Any of

Option 1
Option 2

Type: string

Type: null

Group

Type: null

Roles

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

Each item of this array must be:

Type: string

Web Shell

Type: boolean

Call parameters

Tuple Validation

Parameter 1: privilege_create

privilege_create

name Required

Name

local_groups

Local Groups

Each item of this array must be:

ds_groups

Ds Groups

Each item of this array must be:

Any of

roles

Roles

Each item of this array must be:

web_shell Required

Web Shell

Return value

PrivilegeEntry

id Required

Id

builtin_name Required

Builtin Name

Any of

name Required

Name

local_groups Required

Local Groups

Each item of this array must be:

Any of

GroupEntry

id Required

Id

gid Required

Gid

name Required

Name

builtin Required

Builtin

sudo_commands

Sudo Commands

Each item of this array must be:

sudo_commands_nopasswd

Sudo Commands Nopasswd

Each item of this array must be:

smb

Smb

userns_idmap

Userns Idmap

Any of

Must be one of:

group Required

Group

id_type_both Required

Id Type Both

local Required

Local

sid Required

Sid

Any of

roles Required

Roles

Each item of this array must be:

users

Users

Each item of this array must be:

UnmappedGroupEntry

gid Required

Gid

Any of

sid Required

Sid

Any of

group Required

Group

ds_groups Required

Ds Groups

Each item of this array must be:

Any of