UCS@school ID Connector documentation

UCS@school ID Connector documentation#

GNU AGPL V3 license Python 3.8

Welcome to the documentation for the UCS@school ID Connector.

The ID Connector connects an UCS@school directory to any number of other UCS@school directories in a 1:n relation. It’s designed to connect state directories with school districts, but you can also use it in other contexts. The connection takes place unidirectional. The connector transfers user data such as user, school affiliation, class affiliations from a central directory, for example a country directory, to district or school directories.

Prerequisite is the UCS@school Kelvin API in the school authority environments. This requires a configuration in advance to create an assignment “Which remote instance needs which school users?” Then the connector creates, updates, or deletes these users.

This documentation is for operators and system administrators who want to synchronize user identities between different school environments operated with UCS@school. You need to be familiar with the following topics:

  • The concepts of UCS@school and Univention Corporate Server (UCS), such as the domain concept, UDM, and UCR.

  • Software deployment on UCS, especially how to use the App Center and app settings

  • UCS@school Kelvin REST API

  • Work on the Linux command-line, view and edit text files, and examine log files.

_images/ucsschool-id-connector_overview_extended.svg

Fig. 1 Topology of the UCS@school ID Connector#

In this documentation, you learn how to manage an ID Connector setup, and how to develop plugins for ID Connector.

Tip

The ID Connector setup is primarily used in German-speaking countries. Hence, you encounter a few German terms in this documentation.

Sender

Refers to the sending side of the sync process, which in Germany most likely is a state department.

Traeger

This is the organization managing schools. In the ID Connector context it’s the recipient of sync data.

Tip

You can use the clipboard icon on the top right of code examples to copy the code without Python and Bash prompts:

$ echo "hello world"

Hover with your mouse over the code to see the icon.