Liste der Benutzerrollen über die Learn365-API abrufen

Mit der Learn365-API können Sie eine Liste aller Rollen abrufen, die einem Benutzer oder einer Gruppe zugewiesen sind. In diesem Artikel wird beschrieben, wie Sie eine Liste dieser Rollen abrufen.

Um die einem Benutzer oder einer Gruppe zugewiesenen Rollen abzurufen, gehen Sie wie folgt vor:

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

2. Suchen Sie den Abschnitt RolesAssignments , erweitern Sie ihn, suchen Sie die GET-Methode /odata/v2/RoleAssignments mit der Beschreibung Returns the list of role assignments und wählen Sie anschließend oben rechts Try it out aus.

3. Sie können Abfrageoptionsparameter verwenden um die Daten in der Antwort zu steuern.

Wenn für die Felder keine Abfrageoptionsparameter verwendet werden, enthält die Antwort Informationen zu allen Rollenzuweisungen des Tenants.

Sie können zum Beispiel die ID des betreffenden Benutzers oder der betreffenden Gruppe verwenden, um die Antwort einzugrenzen und eine Liste der Rollen abzurufen, die einem bestimmten Benutzer oder einer bestimmten Gruppe zugewiesen sind. Geben Sie dazu im Feld $filter UserId eq <id of the user or group in question> ein, zum Beispiel UserId eq d822c362-5b86-41b0-8261-57220470c89f.

Als weiteres Beispiel möchten wir eine Liste der Rollenzuweisungen innerhalb eines bestimmten Kurses abrufen. Vorgehensweise:

• Geben Sie im Feld $expand User($select=PrincipalType) ein, damit die Antwort den Parameter PrincipalType enthält, der angibt, wem die Rolle zugewiesen wurde (einem Benutzer oder einer Gruppe).
• Geben Sie im Feld $filter RoleScope/CourseId eq <ID des Kurses> ein, zum Beispiel RoleScope/CourseId eq 09e99b42-9000-4b18-a818-9e7964547013.
   

In diesem Beispiel zeigt die Antwort eine Liste aller Rollenzuweisungen des Kurses mit dem Parameter PrincipalType, der angibt, ob die Rolle einem Benutzer oder einer Gruppe zugewiesen ist.

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

5. Gehen Sie zum Block Responses , um die Ergebnisse zu kontrollieren:

• Die Zahl 2xx (zum Beispiel 200) unter Code zeigt an, dass die Anfrage korrekt ausgeführt wurde.
• Im Feld Response body sehen Sie eine Liste der Rollen, die Benutzern und Gruppen aller Kurskataloge des Tenants zugewiesen sind, sowie deren Daten, einschließlich der ID. Wenn die Parameter für Abfrageoptionen festgelegt sind, enthält die Antwort nur die relevanten Daten und Details.
• Suchen Sie nach einem bestimmten Benutzer oder einer bestimmten Gruppe mit Ctrl+F und kopieren Sie ihn bzw. sie, um ihn bzw. sie überall dort zu verwenden, wo Sie ihn bzw. sie benötigen. Sie können die Option Download verwenden, um die Ergebnisse der API-Anfrage auf Ihrem Computer im .JSON-Format zu speichern.

Die Rolle kann eine der folgenden sein:

• Lernende/Lernender. Benutzer oder Gruppe ist für den Kurs oder den Schulungsplan registriert.
• LMS-Administrator. Dem Benutzer ist die Rolle als LMS-Administrator zugewiesen.
• Kursadministrator. Benutzer oder Gruppe ist als Administrator eines Kurses oder Schulungsplans zugewiesen.
• Kurskatalogadministrator. Dem Benutzer ist die Rolle als Administrator eines Katalogs zugewiesen.
• Kursleiter. Dem Benutzer ist die Rolle als Sitzungsleiter zugewiesen.
• Kurskatalogbesucher. Der Benutzer wird der Liste Users eines bestimmten Katalogs hinzugefügt.
• Kursbesucher. Der Benutzer wird der Zielgruppe eines bestimmten Kurses hinzugefügt.