Generischer Token Anbieter

1. Der Generischer Token Anbieter ist ein Typ eines externen Service Anbieters, der Zugriffstoken aus einem externen System abruft und diese für geschützte Medienaufrufe bereitstellt.

2. Auf der Beschreibung auf der Registerkarte „Tab“ werden folgende Felder der Konfiguration angezeigt:

Name* (max. 50 Zeichen)

• Was es ist: Interner Name dieser konkreten Token-Provider-Konfiguration.

• Empfehlung:
  Es sollte ein Name verwendet werden, der sowohl die Zielplattform als auch die Umgebung (Prod, Test, Region) angibt.

Beschreibung (max. 2000 Zeichen)

• Was es ist: Optionale Freitext-Beschreibung für Administratoren.

• Was hier stehen soll:

  • Zweck des Veranstalters (welche Lerninhaltetypen / Integrationen nutzen ihn).

  • Links zur Dokumentation des externen Systems.

  • Etwaige Einschränkungen (z. B. Gültigkeitsdauer des Tokens, Ratenbeschränkungen).

Name des Token-Endpunkts* (max. 255 Zeichen)

• Was es ist: Logischer oder technischer Name des Token-Endpunkts, mit dem dieser Veranstalter kommuniziert.
  Dieser Wert wird im Bereich token_endpoint_name der Tabelle generischer_Token-Anbieter verwendet, wodurch verschiedene Token-Dienste unterschieden werden können.

• Typische Verwendung:

  • Eine Service-ID, die vom Infrastrukturteam verwendet wird.

  • Oder ein beschreibender Name, der „System“ und „Endpunkt“ kombiniert.

• Wichtig:
  Dieses Feld ist verpflichtend notwendig. Ohne diese Angabe kann der Veranstalter nicht gespeichert werden.

URL des externen Endpunkts* (max. 255 Zeichen)

• Was es ist: Die tatsächliche URL, die das LMS aufruft, um das Token vom externen System abzurufen.

• Beispiele:

  • https://idp.customer.com/api/token/lerninhalte

• Leitlinien:

  • Es sollten ausschließlich HTTPS-URLs verwendet werden.

  • Es sollte die URL des Endpunkts verwendet werden, der das Token in dem vom Konnektor erwarteten Format zurückgibt.

  • Wenn eine Organisation für jede Umgebung (DEV/QA/PROD) unterschiedliche URLs verwendet, sollte für jede Umgebung ein generischer Token-Veranstalter erstellt werden.

• Wichtig:
  Dieses Feld ist verpflichtend notwendig. Ist das Feld leer, wird das Speichern verhindert.

Connector-Klasse* (Dropdown-Menü)

• Was es ist: Die technische Implementierung des Konnektors, die den externen Endpunkt aufrufen und das Token aus der Antwort extrahieren kann.

• Woher es stammt:
  Die Connector-Klassen werden von Scheer IMC bzw. dem technischen Team implementiert und bereitgestellt. Es wird eine der verfügbaren Optionen ausgewählt.

• So auswählen:

  • Für jeden Veranstalter wird der für diese Integration dokumentierte Konnektor ausgewählt.

• Wichtig:
  Dieses Feld ist verpflichtend notwendig. Wenn kein Konnektor nominiert ist, kann die Token-Abfrage nicht funktionieren.

Payload-Felder (max. 1000 Zeichen)

• Was es ist: Optionale Liste von Payload-Feldern, die der Konnektor je nach seiner Ausgestaltung an den externen Endpunkt sendet (beispielsweise als Abfrageparameter oder JSON-Felder).

• Typische Inhalte:

  • Durch Kommas getrennte Namen der Felder, z. B.
    userId, courseId, sessionId

  • Eine Schlüssel-Wert-Liste, falls der Konnektor dies erwartet, z. B.
    userId={USER_ID};mediaId={MEDIA_ID}

• So wird dieses Formular ausgefüllt:

  1. Die Dokumentation zum externen Token-Dienst lesen.

  2. Es ist zu ermitteln, welche Identifikatoren bei der Beantragung eines Tokens übermittelt werden müssen (z. B. Nutzer-ID, Mandant, Medien-Identifikator).

  3. Diese werden im für den Konnektor vorgegebenen Format eingegeben (in der Projektdokumentation sollte angegeben sein, ob es sich um CSV, Schlüssel-Wert-Paare, eine JSON-Vorlage usw. handelt).

• Hinweis:
  Wenn der Connector keine zusätzlichen Payload-Felder benötigt (wenn er beispielsweise nur Client-Anmeldedaten verwendet), kann dieses Feld leer bleiben.

Profil-Identifikator-Attribut* (max. 100 Zeichen)

• Was es ist: Das Attribut des LMS-Benutzerprofils, das bei der Anforderung des Tokens als „Identifikator des Nutzers“ verwendet wird.
  Der Connector liest dieses Attribut in der Regel vom aktuellen Lerner aus und fügt es in die Payload oder die Anfrage ein.

• Häufige Beispiele:

  • Benutzername / user_id

  • Mitarbeiterzahl

  • Jedes andere Profilattribut, das von der Integration als primärer Identifikator verwendet wird.

• So auswählen:

  1. Beim Integrations- bzw. IdP-Team erkundigen, welches LMS-Attribut der Token-Dienst erwartet.

  2. Dieser Name des Attributs wird genau so eingegeben, wie er im System definiert ist.

• Wichtig:
  Dieses Feld ist auch in der Benutzeroberfläche als Pflichtfeld gekennzeichnet. Wenn es für den Konnektor notwendig ist, führt das Leeren des Feldes zu Validierungsfehlern oder Laufzeitfehlern.