Administration

Institute Settings

No API keys issued yet.

Issue A Key

A key authenticates as its own service principal — grant it roles and/or explicit permission patterns, all administered through Alfiz like any person.

Name*

Roles

LMS administrator — Runs the LMS: classes, enrollment, attendance, courses, programs, scheduling and API keys, and can preview the portal as a role or person.Teaching staff — The permissions teachers use — attendance, rosters, materials and grades, announcements, offering courses, interview outcomes. Given automatically to anyone who teaches a class or holds a role that runs one. On its own it opens no class: it counts only on classes the person teaches, for the parts the class's Teacher role (or their role there) allows.Payment manager — Works the Finance dashboard: confirms bank transfers and Zelle receipts, marks tuition paid, issues enrolment codes, marks refunds sent, and reads the collection metrics. Nothing else in the LMS.Student — Sees their own classes, attendance record, the courses they hold, and their programs.

Permission patternsOptional — granted on top of any roles. Wildcards like lms.attendance.* cover a whole group.

Using The API

Send the token on every request: Authorization: Bearer <token> — base URL /api/v1.

GET /api/v1/courses — the public course catalog (no key required).
POST /api/v1/enrollments — enrol a person into a class by email or registry uid (needs lms.enrollment.manage).
POST /api/v1/sessions/:id/zoom-import?commit=true — upload a Zoom participants CSV onto a session; omit commit to preview (needs lms.attendance.import).