logo

UCS@school Kelvin REST API 1.8.3 documentation

Contents:

  • Overview
  • Installation and configuration
  • Authentication and authorization
  • OpenAPI / Swagger / ReDoc
  • Resources
    • Resource Roles
    • Resource Schools
    • Resource Users
    • Resource Classes
    • Resource Workgroups
  • Known Issues
  • Python Client Compatibility
  • Bibliography

Download PDF

  • .rst

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

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
  • Bibliography

next

Overview

By Univention GmbH