group.create

Create a new group.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: group_create

group_create

Type: object
No Additional Properties

Gid

Default: null

If null, it is automatically filled with the next one available.

Type: integer

Value must be greater or equal to 0 and lesser or equal to 90000000

Type: null

Name

Type: string

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.

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

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

Result

Type: integer


Required roles: ACCOUNT_WRITE