Flow365-Benutzerkonten über die Learn365-API erstellen oder löschen

Dieser Artikel beschreibt, welche Schritte Sie ausführen müssen, um ein Flow365-Benutzerkonto per API zu erstellen oder zu löschen.

Flow365-Benutzerkonto erstellen

Damit Frontline-Mitarbeiter Schulungen absolvieren können, muss für sie von einem LMS-Administrator ein Flow365-Benutzerkonto erstellt werden. Das Konto wird sofort aktiviert, und der Benutzer meldet sich über einen Link an, den er per E-Mail erhalten hat. 

Dieser Abschnitt beschreibt die Schritte zum Erstellen eines Flow365-Benutzerkontos. Sie können das Konto auch im Learn365 Admin Center erstellen.

Gehen Sie wie folgt vor, um ein Flow365-Benutzerkonto 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 Users den Endpunkt POST /services/users/Users und dann oben rechts die Option Try it out aus.

3. Die folgenden Pflichtparameter für Flow365-Benutzerkonten müssen im Anfragetext stehen:

• title: Vollständiger Name des Benutzers, der in Learn365 angezeigt wird.
• email: E-Mail-Adresse des Benutzers. Sie muss eindeutig sein, d. h., sie darf keinem bestehenden Benutzer gehören.
• userSource: Für Flow365-Benutzerkonten ist als Benutzerquelle AzureB2C anzugeben.
• signInType: Es gibt drei mögliche Anmeldetypen:
  • Email: Der Flow365-Benutzer meldet sich mit seiner E-Mail-Adresse an.
  • Phone: Der Flow365-Benutzer meldet sich mit seiner Telefonnummer an. Geben Sie beim Erstellen eines solchen Benutzers jedoch in jedem Fall auch die E-Mail-Adresse an, da der Benutzer einen Anmeldelink per E-Mail erhält.
  • Username: Der Flow365-Benutzer meldet sich mit seinem Benutzernamen an.
• username: Die Zeichenfolge ist nur für Benutzer mit dem Anmeldeidentitätstyp Username erforderlich. Der Benutzername muss eindeutig sein, d. h., er darf keinem bestehenden Benutzer gehören. Als Sonderzeichen sind nur Unterstrich ( _ ) und Bindestrich ( - ) zulässig. Das erste Zeichen im Benutzernamen muss entweder ein Buchstabe oder eine Zahl sein. 
• profile: Geben Sie für den Anmeldetyp Phone im Objekt profile den folgenden Parameter ein:
  • phone: Telefonnummer des Benutzers. Sie muss eindeutig sein, d. h., sie darf keinem bestehenden Benutzer gehören.

Der Anfragetext könnte wie folgt aussehen:

Für den Anmeldetyp Email:

{
"title": "John Doe",
"email": "jdoe@test.com",
"userSource": "AzureB2C",
"signInType": "Email"
}

Für den Anmeldetyp Phone:

{
"title": "John Doe",
"email": "jdoe@test.com", 
"userSource": "AzureB2C",
"signInType": "Phone",
"profile": {
"phone": "+5555555"
}
}

Für den Anmeldetyp Username:
{
"title": "John Doe",
"username": "j_doe", 
"userSource": "AzureB2C",
"signInType": "Username"
}

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

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

• 200-Code mit den Details des Benutzers im Antworttext signalisiert eine erfolgreiche Antwort.
  Bei Anfragen zum Erstellen von Flow365-Benutzerkonten mit dem Anmeldetyp Username enthält die Antwort den Parameter metadata > TemporaryPassword, den Sie an den neu erstellten Benutzer weitergeben können, damit er sich anmelden kann.  
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.

Der Flow365-Benutzer erhält einen Link sowie (beim Anmeldetyp „Email“) ein temporäres Passwort per E-Mail.

• Wenn Sie das Konto mit dem Anmeldetyp E-Mail-Adresse erstellt haben, meldet sich der Benutzer mit seiner E-Mail-Adresse und dem temporären Passwort an. Bei der ersten Anmeldung muss der Flow365-Benutzer sein temporäres Passwort durch ein neues ersetzen.
• Wenn Sie das Konto mit dem Anmeldetyp Telefonnummer erstellt haben, meldet sich der Benutzer mit seiner Telefonnummer und dem Einmalcode an, den er beim Anmelden erhält.
• Wenn Sie das Konto mit dem Anmeldetyp username erstellt haben, meldet sich der Benutzer mit seinem Benutzernamen und dem in der Antwort bereitgestellten temporären Passwort an. Sie können ein neues temporäres Passwort festlegen, indem Sie das aktuelle im Learn365 Admin Center > All catalogs > User management > Flow365 users zurücksetzen. Bei der ersten Anmeldung muss der Flow365-Benutzer sein temporäres Passwort in ein neues ändern.

Nach dem Anmelden können Flow365-Benutzer auf Flow365 zugreifen.

Flow365-Benutzerkonto löschen

Mit der Learn365-API können Sie ein zuvor aktiviertes Flow365-Benutzerkonto löschen. Wenn Sie ein Benutzerkonto löschen, zählt es nicht zur Gesamtzahl der Flow365-Benutzer in Ihrem Abonnement. Sie können ein Flow365-Benutzerkonto auch im Learn365 Admin Center löschen.

Zum Löschen eines Flow365-Benutzerkontos per API benötigen Sie die ID des betreffenden Benutzers. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.

So löschen Sie ein Flow365-Benutzerkonto:

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 Users den Endpunkt DELETE /services/users/Users/{id} aus und wählen Sie oben rechts Try it out aus.

3. Geben Sie in das Feld id eine Benutzer-ID ein.

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

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

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