group.update

Update attributes of an existing group.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

Parameter 2: group_update

group_update

Type: object
No Additional Properties

name

Name

Type: string

sudo_commands

Sudo Commands

Type: array of string
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
No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

smb

Smb

Type: boolean

userns_idmap

Userns Idmap

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

users

Users

Type: array of integer

A list of user ids (id attribute from user.query).

No Additional Items

Each item of this array must be:

Type: integer

Return value

Result

Type: integer

Required roles: ACCOUNT_WRITE