Skip to main content

Roles & Permissions

Roles let you control what teachers can see and do in ClassBuddy. Each role is a named collection of permissions. You can create as many roles as you need and assign them to individual teachers.

A teacher can hold multiple roles. Their effective access is the union of all permissions across every role assigned to them.

note

Creating, editing, and deleting roles requires the role:update permission. Removing a role from a teacher requires the teacher:update permission.


View Roles

Go to Settings > Roles to see all roles.

Roles list

Each card shows the role name and description. Tap a card to open the role detail view.


Create a Role

Tap the + button to create a new role.

Create role form

FieldDescription
NameA short, descriptive name for the role (e.g. "Class Teacher", "Admin Staff")
DescriptionA brief explanation of what this role is for
PermissionsSelect one or more permissions from the list
Selecting role permissions

Tap Submit to create the role. Once created it appears in the roles list.


View Role Details

Tap any role to open its detail view. There are two tabs: Info and Teachers.

Role detail view

The Info tab shows:

  • Role name and description
  • All permissions assigned to the role (displayed as chips)

From the menu (three dots) on the Info tab you can Edit or Delete the role.

caution

Deleting a role removes it from all teachers currently assigned to it.


Edit a Role

From the Info tab menu, choose Edit to update the role name, description, or permissions.


Assign Teachers to a Role

Go to the Teachers tab on the role detail view. It shows all teachers currently assigned to this role.

Role teachers

Tap the + button to assign teachers. A multi-select dialog lists all teachers who have a ClassBuddy account and are not already assigned to this role. Select one or more and confirm.

note

Only teachers who have signed up on the ClassBuddy app appear in this list. Teachers must log out and log back in for new permissions to take effect.

Use the search bar to filter the list by teacher name.


Remove a Teacher from a Role

On the Teachers tab, tap the unlink icon next to a teacher to remove them from the role. Confirm when prompted.

You can also remove a role from a teacher's own profile page. See Teachers for details.


Permissions Reference

The following permissions can be assigned to roles. Group them into roles that match how your staff are structured.

Administration

PermissionWhat it allows
is_adminFull access — equivalent to the school account holder. Grants all actions.

Students

PermissionWhat it allows
student:readView students
student:updateEdit student details and status
student:deleteDelete students

Teachers

PermissionWhat it allows
teacher:readView teachers
teacher:updateEdit teacher details, assign and remove roles
teacher:deleteDelete teachers

Entities

PermissionWhat it allows
entity:readView student and teacher records
entity:updateEdit student and teacher records
entity:deleteDelete student and teacher records

Classes & Schedules

PermissionWhat it allows
event:readView classes
event:updateEdit classes
event:deleteDelete classes
schedule:readView schedules
schedule:updateEdit schedules
schedule:deleteDelete schedules

Attendance

PermissionWhat it allows
attendance:readView attendance records
attendance:updateMark and edit attendance
attendance:deleteDelete attendance records

Billing

PermissionWhat it allows
billing:readView billing plans and invoices
billing:updateEdit billing plans and invoices
billing:deleteDelete billing plans and invoices

Forms

PermissionWhat it allows
form:readView forms
form:updateCreate and edit forms
form:deleteDelete forms
form_config:readView form fields
form_config:updateEdit form fields
form_config:deleteDelete form fields
form_submission:readView form submissions
form_submission:updateArchive submissions and add notes
form_submission:deleteDelete form submissions

Contacts

PermissionWhat it allows
contact:readView contacts
contact:updateAdd and edit contacts
contact:deleteDelete contacts

Attributes

PermissionWhat it allows
attribute:readView attributes and lookup values
attribute:updateCreate and edit attributes
attribute:deleteDelete attributes

Addresses

PermissionWhat it allows
address:readView addresses
address:updateCreate and edit addresses
address:deleteDelete addresses

Roles

PermissionWhat it allows
role:readView roles
role:updateCreate, edit, delete roles, and assign them to teachers
role:deleteDelete roles

Settings

PermissionWhat it allows
setting:readView school settings
setting:updateEdit school settings

Messaging

PermissionWhat it allows
message:sendSend messages to students, teachers, and classes

Data Import

PermissionWhat it allows
data_import:createUpload CSV files to bulk import data
data_import:readView upload history and results

note

Teachers always have read access to schedules they are personally assigned to, regardless of their role permissions.