Skip to main content

get_access_control_list

Get all access control rules for this tenant, ordered by area then role.
Property
Read-onlyYes

Parameters

None.

Returns

A list of ConfigAccessControl objects. Each rule maps an area + role to user groups:
  • id — rule identifier
  • area — the security area (e.g. Container, Board)
  • role — the permission role (e.g. View, Add, Manage, Change, Delete)
  • userGroup — list of user group IDs granted this role

create_access_control_area

Create a new access control area with 5 default roles (View, Add, Manage, Change, Delete).
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
areaNamestringYesArea name. Sanitized to alphanumeric characters.

Returns

A confirmation message. Requires super admin.

update_access_control

Update an access control rule’s user group assignments.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
accessControlIdstringYesThe rule ID. Use get_access_control_list.
userGroupIdsstring[]NoNew user group IDs. Use get_user_group_list.

Returns

The updated ConfigAccessControl. Requires super admin.

delete_access_control

Delete an access control rule.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
accessControlIdstringYesThe rule ID. Use get_access_control_list.

Returns

A confirmation message. Requires super admin.