Welcome to UCS@school ID Connector’s documentation!

The ID Connector connects an UCS@school directory to any number of other UCS@school directories (1:n). It is designed to connect state directories with school districts, but can also be used in other contexts. The connection takes place unidirectional: user data (user, school affiliation, class affiliations) is transferred from a central directory (e.g. country directory) to district or school directories. Prerequisite is the use of the UCS@school Kelvin API on the school authorities. For this a configuration is necessary in advance to create an assignment “Which school users should be transferred to which remote instance?” Then these users are created, updated and deleted.

In this documentation, you will learn how to administer an ID Connector setup, and we hope to teach you how to develop plugins for ID Connector as well.

Note

At the moment, the ID Connector setup is only used in German-speaking countries. Hence, you will encounter a few German terms in this documentation.

Sender

An easy one to guess - it actually 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 can be thought of as the recipient of sync data.

Note

You can use the clipboard icon on the top right of code examples to easily copy the code without python and bash prompts:

$ echo "hello world"

(Hover with your mouse over the code to see the icon)

Contents

• 1. Administration
  • 1.1. Admin overview
  • 1.2. Admin prerequisites
  • 1.3. Installation
    • 1.3.1. Sending system
    • 1.3.2. Receiving system
  • 1.4. Configuration
    • 1.4.1. Configure receiving system - HTTP-API (Kelvin)
    • 1.4.2. Configure sending system
      • UCS@school ID Connector HTTP API
      • Authentication
      • School authorities mapping
      • School to authority mapping
      • Role specific attribute mapping
      • Partial group sync mapping
  • 1.5. Trying it out
  • 1.6. Starting / Stopping services
  • 1.7. Updates
  • 1.8. Extra: setting up a second school authority
• 2. Development
  • 2.1. Overview
  • 2.2. Prerequisites
  • 2.3. Interactions and components
    • 2.3.1. Overview, less simplified
    • 2.3.2. DC Primary
    • 2.3.3. ID Connector
    • 2.3.4. Complete picture
  • 2.4. Setup
    • 2.4.1. Machine
    • 2.4.2. Virtual machine
    • 2.4.3. Run unit tests
  • 2.5. Plugin development
    • 2.5.1. How does the plugin system work?
    • 2.5.2. A simple custom plugin
    • 2.5.3. Advanced example
  • 2.6. Building
    • 2.6.1. Build docker image
    • 2.6.2. Build release image
  • 2.7. Integration tests
• 3. File locations
  • 3.1. Log files
  • 3.2. School authority configuration files
  • 3.3. Queue files
  • 3.4. Token signature key
  • 3.5. SSL certificates for Kelvin client plugin
  • 3.6. Volumes
• 4. Example json configurations
  • 4.1. Sending system examples
    • 4.1.1. School authority configuration
    • 4.1.2. School to authority mapping example
    • 4.1.3. Role specific Kelvin plugin mapping
    • 4.1.4. Partial group sync
  • 4.2. Receiving system examples
    • 4.2.1. Mapped UDM properties
• 5. Changelog
• 6. Bibliography

Indices and tables

• Index

• Search Page