group.update

Update attributes of an existing group.

Type: object

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

Type: string

Sudo Commands

Type: array of string

A list of commands that group members may execute with elevated privileges. User is prompted for password when executing any command from the list.

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

A list of commands that group members may execute with elevated privileges. User is not prompted for password when executing any command from the list.

No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Smb

Type: boolean

If set to True, the group can be used for SMB share ACL entries. The group is mapped to an NT group account on the TrueNAS SMB server and has a sid value.

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

A list a API user identifiers for local users who are members of this group. These IDs match the id field from user.query.

NOTE: This field is empty for groups that come from directory services (local is False).

No Additional Items
Each item of this array must be:
Type: integer

Result

Type: integer


Required roles: ACCOUNT_WRITE