# 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

##

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:

## Any of

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

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

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

Type: string

##

#### Web Shell

Type: boolean

Required roles: PRIVILEGE_WRITE