privilege.update¶
Update the privilege id.
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerParameter 2: privilege_update
privilege_update
Type: objectNo Additional Properties
Name
Type: stringMust be at least 1 characters long
Local Groups
Type: array of integerNo Additional Items
Each item of this array must be:
Ds Groups
Type: arrayNo Additional Items
Each item of this array must be:
Roles
Type: array of stringNo Additional Items
Each item of this array must be:
Web Shell
Type: booleanPrivilegeEntry
Type: objectNo Additional Properties
Id
Type: integerBuiltin Name
Name
Type: stringMust be at least 1 characters long
Local Groups
Type: arrayNo Additional Items
Each item of this array must be:
GroupEntry
Type: objectNo Additional Properties
Id
Type: integerThis is the API identifier for the group. Use this ID for group.update and group.delete API calls. This ID also appears in the groups array for each user entry in user.query results.
NOTE: For groups from a directory service, the id is calculated by adding 100000000 to the gid. This ensures consistent API results. You cannot change directory service accounts through TrueNAS.
Gid
Type: integerA non-negative integer used to identify a group. TrueNAS uses this value for permission checks and many other system purposes.
Name
Type: stringA string used to identify a group.
Must be at least 1 characters long
Builtin
Type: booleanIf True, the group is an internal system account for the TrueNAS server. Typically, one should create dedicated groups for access to the TrueNAS server webui and shares.
Sudo Commands
Type: array of string Default: []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 ItemsEach item of this array must be:
Must be at least 1 characters long
Sudo Commands Nopasswd
Type: array of string Default: []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 ItemsEach item of this array must be:
Must be at least 1 characters long
Smb
Type: boolean Default: trueIf 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
Default: nullSpecifies 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.
Must be one of:
- "DIRECT"
"DIRECT" Value must be greater or equal to 1 and lesser or equal to 4294967294
Group
Type: stringA string used to identify a group. Identical to the name key.
Must be at least 1 characters long
Local
Type: booleanIf True, the group is local to the TrueNAS server. If False, the group is provided by a directory service.
Sid
The Security Identifier (SID) of the user if the account an smb account. The SMB server uses this value to check share access and for other purposes.
Roles
Type: array of stringList of roles assigned to this groups. Roles control administrative access to TrueNAS through the web UI and API. You can change group roles by using privilege.create, privilege.update, and privilege.delete.
Each item of this array must be:
Users
Type: array of integer Default: []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).
Each item of this array must be:
UnmappedGroupEntry
Type: objectNo Additional Properties
Gid
Sid
Group
Type: nullDs Groups
Type: arrayNo Additional Items
Each item of this array must be:
GroupEntry
Type: objectNo Additional Properties
Id
Type: integerThis is the API identifier for the group. Use this ID for group.update and group.delete API calls. This ID also appears in the groups array for each user entry in user.query results.
NOTE: For groups from a directory service, the id is calculated by adding 100000000 to the gid. This ensures consistent API results. You cannot change directory service accounts through TrueNAS.
Gid
Type: integerA non-negative integer used to identify a group. TrueNAS uses this value for permission checks and many other system purposes.
Name
Type: stringA string used to identify a group.
Must be at least 1 characters long
Builtin
Type: booleanIf True, the group is an internal system account for the TrueNAS server. Typically, one should create dedicated groups for access to the TrueNAS server webui and shares.
Sudo Commands
Type: array of string Default: []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 ItemsEach item of this array must be:
Must be at least 1 characters long
Sudo Commands Nopasswd
Type: array of string Default: []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 ItemsEach item of this array must be:
Must be at least 1 characters long
Smb
Type: boolean Default: trueIf 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
Default: nullSpecifies 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.
Must be one of:
- "DIRECT"
"DIRECT" Value must be greater or equal to 1 and lesser or equal to 4294967294
Group
Type: stringA string used to identify a group. Identical to the name key.
Must be at least 1 characters long
Local
Type: booleanIf True, the group is local to the TrueNAS server. If False, the group is provided by a directory service.
Sid
The Security Identifier (SID) of the user if the account an smb account. The SMB server uses this value to check share access and for other purposes.
Roles
Type: array of stringList of roles assigned to this groups. Roles control administrative access to TrueNAS through the web UI and API. You can change group roles by using privilege.create, privilege.update, and privilege.delete.
Each item of this array must be:
Users
Type: array of integer Default: []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).
Each item of this array must be:
UnmappedGroupEntry
Type: objectNo Additional Properties
Gid
Sid
Group
Type: nullRoles
Type: array of string Default: []No Additional Items
Each item of this array must be:
Web Shell
Type: booleanRequired roles: PRIVILEGE_WRITE