GET
/api/v1/access-control/rolesList
role:viewMODULE GUIDE · 11 OCT 2026
Roles & permissions
Control which school users can view, create, edit, export and manage records.
OVERVIEW
What you can do
01
Role catalogue
02
Permission catalogue
03
Role grants
04
User assignment
BEFORE YOU BEGIN
Access & setup
Intended access: Assigned account with the required permissions.
- An assigned school account with the required permissions.
- The academic, student or staff setup used by this workflow.
Required permission keys
role:viewrole:createrole:updaterole:deleterole:manageUse the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
STEP BY STEP
How the workflow works
- 01
Open a role and inspect its existing permissions
An assigned school account with the required permissions.
- 02
Choose only the required permission keys
Permission catalogue is part of the documented workflow.
- 03
Save the role and assign eligible users
Role grants is part of the documented workflow.
- 04
Sign in as the affected role to review access
Review the result in the connected record or workspace before moving on.
Request fields to understand
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
name | string | Optional |
key | string | Required by declaration |
description | string | Optional |
permissionKeys | string[] | Required by declaration |
userId | string | Required by declaration |
CURRENT BEHAVIOUR
Rules & current limits
- A role name alone does not grant platform administration. School scope and explicit guards still apply.
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
LEARN BY DOING
Launch guided demo →Try roles & permissions
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
FOR IMPLEMENTERS
API & permissions reference
This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.
10 source-declared operations
GET
/api/v1/access-control/permissionsPermission Catalog
role:viewGET
/api/v1/access-control/roles/:idGet
role:viewPOST
/api/v1/access-control/rolesCreate
role:createDeclared request fields: name (required), key (required), description (optional).
PATCH
/api/v1/access-control/roles/:idUpdate
role:updateDeclared request fields: name (optional), description (optional).
DELETE
/api/v1/access-control/roles/:idRemove
role:deletePUT
/api/v1/access-control/roles/:id/permissionsSet Permissions
role:manageDeclared request fields: permissionKeys (required).
GET
/api/v1/access-control/roles/:id/assignable-usersAssignable Users
role:managePOST
/api/v1/access-control/roles/:id/usersAssign User
role:manageDeclared request fields: userId (required).
DELETE
/api/v1/access-control/roles/:id/users/:userIdUnassign User
role:manageOpen the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.