Welcome to ID Broker operations manual!

This documentation is intended for administrators who want to host and maintain the ID Broker.

To follow the text you need to understand the architecture of the ID Broker, UCS and UCS@school. To find more information about these topics, visit the Univention documentation and the Univention ID Broker documentation.

Contents:

• 1. Introduction
• 2. ID Broker Installation
  • 2.1. Primary
  • 2.2. Backup - Self-disclosure API
  • 2.3. Backup - Provisioning API
  • 2.4. Backup - Univention ID Broker Self-disclosure DB Builder
    • 2.4.1. SDDB Installation
  • 2.5. Backup - SSO Service - Keycloak
  • 2.6. All - Performance settings and optimizations
    • 2.6.1. OpenLDAP and UCS directory listener database size
    • 2.6.2. Disable non-essential services
• 3. School authorities
  • 3.1. Add a new school authority
    • 3.1.1. Add a new school authority to Keycloak
  • 3.2. Remove a school authority
• 4. Service providers
  • 4.1. Service provider mapping and secrets
  • 4.2. Registration of a new service provider
  • 4.3. Service/App requirements
• 5. Support
  • 5.1. UCS@school APIs
  • 5.2. Univention ID Broker Self-disclosure DB Builder
    • 5.2.1. SDDB Command line interface
    • 5.2.2. Examples for sddb-builder commands
    • 5.2.3. SDDB REST API
• 6. Release Process
  • 6.1. Pre-release
  • 6.2. Rollout
  • 6.3. Product tests
• 7. Glossary
• 8. Indices and tables