privilege.create

Creates a privilege.

name is a name for privilege (must be unique).

local_groups is a list of local user account group GIDs that gain this privilege.

ds_groups is list of Directory Service group GIDs that will gain this privilege.

roles is a list of roles to be assigned to the privilege

web_shell controls whether users with this privilege are allowed to log in to the Web UI.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: privilege_create

privilege_create

Type: object
No Additional Properties

name Required

Name

Type: string

Must be at least 1 characters long

local_groups

Local Groups

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

Each item of this array must be:

Type: integer

ds_groups

Ds Groups

Type: array Default: []
No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: integer

Type: string

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

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

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

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

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

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

Each item of this array must be:

Type: string

web_shell Required

Web Shell

Type: boolean

Required roles: PRIVILEGE_WRITE