Benutzer über die Learn365-API zu einer benutzerdefinierten Benutzergruppe hinzufügen oder daraus entfernen

Benutzerdefinierte Benutzergruppen sind Gruppen, die Sie über die Learn365-API oder das Learn365 Admin Center 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.

Dieser Artikel beschreibt die Schritte, die Sie befolgen sollten, um Benutzer zu einer benutzerdefinierten Gruppe hinzuzufügen oder daraus zu entfernen.

Um Benutzer einer benutzerdefinierten Gruppe hinzuzufügen bzw. daraus zu entfernen, benötigen Sie:

• Benutzer-ID. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.
• Benutzergruppen-ID. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.

Eine Liste der Benutzer in einer benutzerdefinierten Benutzergruppe anzeigen

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

Zunächst sollten Sie prüfen, welche Benutzer bereits in der benutzerdefinierten Gruppe sind. So gehen Sie über die API vor:

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

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

4. Verwenden Sie bei Bedarf Parameter für Abfrageoptionen, um die Daten in der Antwort zu steuern.

5. Klicken Sie auf Execute, um die Anfrage auszuführen.

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

• Ein 200-Code mit einer Liste von Benutzern im Antworttext weist auf eine erfolgreiche Antwort hin.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.

Benutzer zu einer benutzerdefinierten Benutzergruppe hinzufügen

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

So fügen Sie Benutzer per API zu einer benutzerdefinierten Benutzergruppe hinzu:

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/{groupId}/members aus und wählen Sie oben rechts Try it out aus.

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

4. Geben Sie im Array des Anfragetexts die IDs der Benutzer ein, die Sie der Gruppe hinzufügen möchten.

5. Klicken Sie auf Execute, um die Anfrage auszuführen.

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

• Ein 204-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.

Benutzer aus einer benutzerdefinierten Benutzergruppe entfernen

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

Es gibt zwei Möglichkeiten, Benutzer aus einer benutzerdefinierten Benutzergruppe zu entfernen. Um einen oder mehrere Benutzer über die API aus einer benutzerdefinierten Benutzergruppe zu entfernen:

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:

• DELETE /services/users/v2/Groups/{groupId}/members/{userId}, um einen Benutzer aus einer Gruppe zu entfernen. Bei diesem Endpunkt geben Sie die ID der Benutzergruppe in das Feld groupId und die Benutzer-ID in das Feld userId ein.
• DELETE /services/users/v2/Groups/{groupId}/members, um eine Liste von Benutzern aus einer Gruppe zu entfernen. Bei diesem Endpunkt geben Sie die ID der Benutzergruppe in das Feld groupId ein und im Array für den Anfragetext die IDs der Benutzer, die Sie aus der Gruppe entfernen möchten.

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

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

• Ein 204-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.