Benutzerdefinierte Benutzergruppe per API erstellen oder löschen

Benutzerdefinierte Benutzergruppen sind Gruppen, die Sie über die Learn365-API erstellen und verwalten können. Im Gegensatz zu Microsoft Entra-Gruppen können benutzerdefinierte Benutzergruppen Benutzer jeglicher Art (einschließlich Benutzer aus Learn365 und Flow365) umfassen.

Benutzerdefinierte Benutzergruppen erstellen

Erforderliche Rolle: LMS-Administrator, Katalogadministrator

Gehen Sie wie folgt vor, um eine benutzerdefinierte Benutzergruppe per API zu erstellen:

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 Groups den Endpunkt POST /services/users/v2/Groups aus und klicken Sie oben rechts auf Try it out.

3. Geben Sie im Anfragetext Folgendes ein:

• title: Zeichenfolge (Pflichtparameter). Der Titel muss eindeutig sein, d. h., er darf keiner bestehenden benutzerdefinierten Benutzergruppe oder Microsoft Entra-Gruppe zugewiesen sein. Zum Anzeigen einer Liste der bestehenden vorhandenen benutzerdefinierten Benutzergruppen und Microsoft Entra-Gruppen senden Sie die API-Anfrage GET /services/users/v2/Groups.
• ownerIds: Array (optional). Geben Sie die Benutzer-IDs der Katalogadministratoren ein, um sie zu Besitzern der benutzerdefinierten Benutzergruppe zu machen. Während LMS-Administratoren jede benutzerdefinierte Benutzergruppe in ihrer Organisation verwalten können, können Katalogadministratoren nur diejenigen benutzerdefinierten Benutzergruppen verwalten, deren Besitzer sie sind. Weitere Informationen über Gruppenbesitzer und ihre Berechtigungen finden Sie in diesem Artikel.

Der Anfragetext könnte wie folgt aussehen:

{
 "title": "Audiotechniker",
 "ownerIds": [
 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
 "fa35cdf2-75bd-40b0-ac0d-b5ca7bfde448" 
 ]
}

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

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

• Ein 200-Code für id und title der Gruppe im Antworttext signalisiert eine erfolgreich abgerufene Antwort.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.

Benutzerdefinierte Benutzergruppen löschen

Erforderliche Rolle: LMS-Administrator. Außerdem Katalogadministrator, sofern der Katalogadministrator der Besitzer der Gruppe ist.

Zum Löschen einer benutzerdefinierten Gruppe per API benötigen Sie die Gruppen-ID. Es gibt zwei Möglichkeiten, diese zu ermitteln:

• Beim Erstellen einer benutzerdefinierten Benutzergruppe enthält der Antworttext den Parameter id.
• Sie senden die API-Anfrage GET /services/users/v2/Groups. Weitere Informationen zu dieser Anfrage finden Sie in diesem Artikel.

So löschen Sie eine benutzerdefinierte Benutzergruppe per API:

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 Groups den Endpunkt DELETE /services/users/v2/Groups/{groupId} aus und klicken Sie oben rechts auf Try it out.

3. Geben Sie die ID der Benutzergruppe in das Feld groupId ein.

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

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

• Ein 200-Code für id und title der Gruppe im Antworttext signalisiert eine erfolgreich abgerufene Antwort.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.