auth_suap

auth_suap is a Moodle authentication plugin that implements Single Sign-On (SSO) via OAuth2 against SUAP (Sistema Unificado de Administração Pública — Unified Public Administration System), used at the Instituto Federal do Rio Grande do Norte (IFRN) and other Brazilian federal institutions. Besides authenticating, the plugin synchronizes the user’s institutional data (name, e-mail, CPF, enrollment/employment relationship, course, campus, photo, among others) into custom Moodle profile fields on every login.

Contents

• Overview
  • What the plugin does
  • Requirements
  • Optional dependency
  • Languages
  • Repository structure
  • Organization
• Installation
  • 1. Configuration in SUAP
  • 2. Configuration in Moodle
  • 3. SUAP configuration in Moodle
  • 4. Testing access
• Authentication flow
  • Summary
  • Plugin endpoints
  • Step 1 — login()
  • Step 2 — exchanging the code for a token
  • Step 3 — collecting user data
  • Step 4 — user creation/update
  • Step 5 — completing the login
  • Logout
• User synchronization
  • Profile fields created automatically
  • Fields changed on first login vs. subsequent logins
  • Updating the user’s photo
  • Scheduled task: retroactive photo backfill
  • Bulk action: update photo from the user listing
  • Display name configuration (social name)
  • Scheduled task: retroactive name synchronization
  • Notes
• Privacy
  • What the provider declares
• Development
  • Versioning
  • Pre-commit (mandatory)
  • Running the tests locally with act
  • CI/CD
  • Documentation
  • Manual packaging