Sichtbarkeit von Benutzern aus Microsoft Entra-Gruppen und benutzerdefinierten Benutzergruppen im Learn365 Admin Center per API beschränken

Durch das Erstellen und Verwalten von Gruppenbeschränkungen per API können Sie die Sichtbarkeit und Verfügbarkeit von Benutzern und ihren Gruppen im Learn365 Admin Center ändern. Wenn die Gruppenbeschränkungen beispielsweise aktiviert sind, werden beim Registrieren von Lernenden für eine Schulung nur die Benutzer aus bestimmten Microsoft Entra- oder benutzerdefinierten Benutzergruppen angezeigt.

Sie können Beschränkungen auf beliebig viele Microsoft Entra- oder benutzerdefinierte Benutzergruppen anwenden. Ferner können Sie die Beschränkungen auf bestimmte Kurskataloge begrenzen.

Gehen Sie wie folgt vor, um Gruppenbeschränkungen per API zu erstellen und zu verwalten:

1. Erstellen oder bearbeiten Sie eine Gruppe von Benutzern im Microsoft Entra Admin Center. Sie benötigen auch die Objekt-ID der Gruppe.

2. Unter Angabe der Gruppenobjekt-ID fügen Sie die Microsoft Entra-Gruppe der Beschränkungsliste für Ihre Umgebung über die Learn365-API hinzu.

3. Alternativ fügen Sie die Microsoft Entra- oder benutzerdefinierte Benutzergruppe über ihre Gruppen-ID der Beschränkungsliste hinzu.

4. Zeigen Sie eine Liste der Gruppen auf Ihrer Beschränkungsliste an.

5. Aktivieren Sie die Gruppenbeschränkungen.

6. Falls erforderlich, löschen Sie eine Beschränkung aus Ihrer Beschränkungsliste.

Gruppenbeschränkungen und Personenauswahl im Learn365 Admin Center

Wenn die Gruppenbeschränkungen aktiviert sind, sind in der Personenauswahl im Learn365 Admin Center nur die Benutzer aus den Gruppen verfügbar, die in der Beschränkungsliste enthalten sind. Anders formuliert: Nur Benutzer aus bestimmten Microsoft Entra- oder benutzerdefinierten Benutzergruppen, die auf der Beschränkungsliste für Ihre Umgebung enthalten sind, werden angezeigt, wenn Sie:

• einen LMS-Administrator im Learn365 Admin Center > Alle Kataloge > Benutzerverwaltung > LMS-Administratoren hinzufügen.
• einen Benutzer für eine Schulung registrieren.
• (wenn Sie eine Beschränkung für einen bestimmten Kurskatalog festlegen) einen Benutzer für eine Schulung registrieren aus diesem Kurskatalog.

Microsoft Entra-Gruppen über ihre Objekt-ID einer Beschränkungsliste hinzufügen

Zum Hinzufügen einer Microsoft Entra-Gruppe zu einer Beschränkungsliste in Learn365 über ihre Objekt-ID benötigen Sie eben diese Objekt-ID. Sie finden sie im Microsoft Entra admin center. Weitere Informationen finden Sie in diesem Microsoft-Artikel.

Wenn Sie Beschränkungen für einen bestimmten Kurskatalog anwenden möchten, benötigen Sie ferner die ID des betreffenden Kurskatalogs. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.

Gehen Sie wie folgt vor, um eine Microsoft Entra-Gruppe zu einer Beschränkungsliste hinzuzufügen:

1. Gehen Sie zu https://api.365.systems/, und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Wählen Sie im Abschnitt GroupRestrictions den Endpunkt POST /groupRestrictions/addADGroup aus und klicken Sie dann oben rechts auf die Option Try it out.

3. Geben Sie in das Feld objectId die Objekt-ID einer Microsoft Entra-Gruppe ein.

4. Wenn Sie eine Beschränkung nur für einen bestimmten Kurskatalog hinzufügen möchten, geben Sie im Feld courseCatalogId die ID des Kurskatalogs ein. Wenn dieses Feld leer gelassen wird, gilt die Beschränkung für die gesamte Umgebung.

5. Wählen Sie Execute aus, um die Anfrage auszuführen.

6. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren:

• Ein 200-Code mit einem leeren Antworttext signalisiert eine erfolgreiche Antwort.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.

Gruppen über ihre Gruppen-ID einer Beschränkungsliste hinzufügen

Zum Hinzufügen einer Microsoft Entra- oder einer benutzerdefinierten Benutzergruppe zu einer Beschränkungsliste in Learn365 über ihre Gruppen-ID benötigen Sie eben diese Gruppen-ID. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.

Gehen Sie wie folgt vor, um die Gruppe per API einer Beschränkungsliste hinzuzufügen:

1. Gehen Sie zu https://api.365.systems/, und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Wählen Sie im Abschnitt GroupRestrictions den Endpunkt POST /groupRestrictions/addGroup aus und klicken Sie dann oben rechts auf die Option Try it out.

3. Geben Sie im Feld groupId eine Gruppen-ID ein.

4. Wenn Sie eine Beschränkung nur für einen bestimmten Kurskatalog hinzufügen möchten, geben Sie im Feld courseCatalogId die Kurskatalog-ID ein. Wenn dieses Feld leer gelassen wird, gilt die Beschränkung für die gesamte Umgebung.

5. Select Execute, um die Anfrage auszuführen.

6. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren:

• Ein 200-Code mit einem leeren Antworttext signalisiert eine erfolgreiche Antwort.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.

Eine Liste der Gruppen auf einer Beschränkungsliste anzeigen

Gehen Sie wie folgt vor, um eine Liste aller Gruppenbeschränkungen anzuzeigen, die in Ihrer Umgebung hinzugefügt wurden:

1. Gehen Sie zu https://api.365.systems/ und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Wählen Sie im Abschnitt GroupRestrictions den GET-Endpunkt /groupRestrictionsaus und wählen Sie oben rechts Try it out aus.

3. Select Execute, um die Anfrage auszuführen.

4. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren:

• Ein 200-Code mit einem Array von Beschränkungen signalisiert eine erfolgreiche Antwort. Jedes Element in diesem Array umfasst drei Parameter:
  • Id ist die ID einer einzelnen Beschränkung in Learn365.
  • CourseCatalogId ist die ID des Kurskatalogs, für den die Beschränkung gilt. Wenn das Feld leer ist, gilt die Beschränkung für die gesamte Umgebung.

  • GroupId ist die ID einer Benutzergruppe in Learn365. 

    

• Ein 200-Code mit leerem Antworttext bedeutet, dass in Ihrer Umgebung keine Gruppenbeschränkungen vorhanden sind.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.

Gruppenbeschränkungen ein- und ausschalten

Gehen Sie wie folgt vor, um Gruppenbeschränkungen in Ihrer Umgebung ein- bzw. auszuschalten:

1. Gehen Sie zu https://api.365.systems/ und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Wählen Sie im Abschnitt GroupRestrictions den Endpunkt PUT /groupRestrictions/state endpoint aus und klicken Sie dann oben rechts auf Try it out.

3. Wählen Sie im Feld isEnabled true aus, um die Beschränkungen zu aktivieren, oder false, um sie zu deaktivieren.

4. Wählen Sie Execute aus, um die Anfrage auszuführen.

5. Gehen Sie zum Block Response, um die Ergebnisse zu überprüfen:

• Ein 200-Code mit einem leeren Antworttext signalisiert eine erfolgreiche Antwort.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.

Beschränkungen gelten nur für die Beschränkung auf einer Beschränkungsliste. Sie können die Liste über die GET-Anfrage /groupRestrictions einsehen.

Wenn die Gruppenbeschränkungen aktiviert sind, sind in der Personenauswahl im Learn365 Admin Center nur die Benutzer aus den Gruppen verfügbar, die in der Beschränkungsliste enthalten sind.

Beschränkung von einer Beschränkungsliste löschen

Wenn Sie eine bestimmte Beschränkung löschen möchten, benötigen Sie deren ID. Sie können sie ermitteln, indem Sie die GET-Anfrage /groupRestrictions senden und den Parameter Id in der Antwort prüfen.

Gehen Sie wie folgt vor, um eine bestimmte Beschränkung aus einer Beschränkungsliste zu löschen:

1. Gehen Sie zu https://api.365.systems/ und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Wählen Sie im Abschnitt GroupRestrictions den Endpunkt DELETE /groupRestrictions endpoint aus und klicken Sie dann oben rechts auf Try it out.

3. Geben Sie im Feld id eine Beschränkungs-ID ein.

4. Select Execute, um die Anfrage auszuführen.

5. Gehen Sie zum Block Response, um die Ergebnisse zu prüfen:

• Ein 200-Code mit einem leeren Antworttext signalisiert eine erfolgreiche Antwort.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.

Beschränkungen für mehrere Umgebungen (Organisationen) im selben Mandanten hinzufügen

Wenn Sie mehrere Umgebungen (Organisationen) innerhalb eines einzelnen Tenants eingerichtet haben, können Sie die Sichtbarkeit von Microsoft Entra-Gruppen und -Benutzern per API umgebungsübergreifend einschränken. Für benutzerdefinierte Benutzergruppen und Flow365-Benutzer ist das Einrichten einer Sichtbarkeitseinschränkung nicht erforderlich, da ihre Sichtbarkeit standardmäßig auf die jeweilige Umgebung beschränkt ist.

Die Einschränkung der Sichtbarkeit in verschiedenen Umgebungen wird mithilfe bestimmter API-Schlüssel gesteuert. Gehen Sie wie folgt vor, um die Einschränkung für genau eine der Umgebungen festzulegen:

1. Vergewissern Sie sich, dass Sie über einen aktiven API-Schlüssel für die Umgebung verfügen.

2. Autorisieren Sie sich auf https://api.365.systems/ mit dem API-Schlüssel.

3. Fügen Sie Microsoft Entra-Benutzer oder -Gruppen zur Beschränkungsliste hinzu.

4. Aktivieren Sie die Gruppenbeschränkung für die Umgebung. Wenn die Gruppenbeschränkungen aktiviert sind, sind nur Benutzer aus der Gruppe, die auf der Beschränkungsliste enthalten ist, in der Personenauswahl im Learn365 Admin Center für die Umgebung verfügbar.