Welcome to UCS@school Kelvin REST API’s documentation!

Contents:

• Overview
  • Components
• Installation and configuration
  • Installation
  • Configuration
  • File locations
• Authentication and authorization
  • Authentication
  • Authorization
• OpenAPI / Swagger / ReDoc
  • Interactive API browser
  • Generating client code from OpenAPI schema
• Resources
  • Resource Roles
  • Resource Schools
  • Resource Users
  • Resource Classes
  • Resource Workgroups
• Known Issues
  • Rebuilding the UDM REST API Client
  • No pagination
  • Creating schools does not work in single server environments
• Python Client Compatibility
• Changelog
  • v2.0.0 (2025-03-14)
  • v1.10.3 (2024-12-09)
  • v1.10.2 (2024-10-07)
  • v1.10.1 (2024-07-25)
  • v1.10.0 (2024-03-05)
  • v1.9.0 (2023-10-17)
  • v1.8.10 (2023-08-24)
  • v1.8.9 (2023-05-19)
  • v1.8.8 (2023-05-04)
  • v1.8.7 (2023-03-30)
  • v1.8.6 (2023-03-07)
  • v1.8.5 (2023-02-22)
  • v1.8.4 (2023-02-16)
  • v1.8.3 (2023-01-16)
  • v1.8.2 (2022-12-20)
  • v1.8.1 (2022-12-07)
  • v1.8.0 (2022-11-11)
  • v1.7.0 (2022-07-18)
  • v1.6.0 (2022-08-24)
  • v1.5.6 (2022-06-30)
  • v1.5.5 (2022-06-23)
  • v1.5.4 (2022-04-27)
  • v1.5.3 (2022-02-08)
  • v1.5.2 (2022-01-07)
  • v1.5.1 (2021-11-30)
  • v1.5.0 (2021-09-10)
  • v1.4.4 (2021-06-29)
  • v1.4.3 (2021-06-16)
  • v1.4.2 (2021-05-26)
  • v1.4.1 (2021-05-03)
  • v1.4.0 (2021-04-20)
  • v1.3.0 (2021-02-18)
  • v1.2.0 (2020-11-12)
  • v1.1.2 (2020-08-11)
  • v1.1.1 (2020-06-15)
  • v1.1.0 (2020-04-15)
  • v1.0.1 (2020-02-17)
  • v1.0.0 (2020-01-20)
• Bibliography