Wie können Benutzer über die API erstellt werden?

Du kannst mehrere Benutzer gleichzeitig erstellen oder aktualisieren, indem du die entsprechende API-Anfrage verwendest. Alle Felder, die als „required“ gekennzeichnet sind, müssen für jeden Benutzer gesendet werden; die anderen Felder sind optional.

Es ist auch wichtig, im Feld „login“ anzugeben, ob sich die Benutzer über SSO („identity_provider“) oder Passwort („password“) einloggen. Beachte, dass „identity_provider“ nur für SAML SSO erforderlich ist. Frage deine Flip-Kontaktperson nach dem richtigen Wert für „alias“.

Müssen Passwörter für Benutzer über die API gesendet werden, oder wann ist das notwendig?

Benutzer, die keinen SSO-Zugang haben, benötigen ein Passwort, um sich in ihrer Mitarbeiter-App anzumelden.

In der Regel wird ein temporäres Passwort zugewiesen, wenn ein Benutzer über die API erstellt wird. Um dies zu erreichen, weise im Request „Create or update multiple users at once“ unter „login“ das Feld „password“ zu und setze das Feld „temporary“ auf true.

Die folgenden Passwort-Richtlinien gelten standardmäßig:

• Das Passwort darf nicht mit den letzten 3 Passwörtern eines Benutzers übereinstimmen.
• Das Passwort sollte eine Mindestlänge von 8 Zeichen haben.
• Das Passwort darf nicht dem Benutzernamen entsprechen.

Wenn die Passwort-Richtlinien deines Unternehmens abweichen, informiere bitte deinen Flip-Kontakt.

Wofür ist der Identitätsprovider-Link („identity_provider“) und wie sollte er eingestellt werden?

Beachte, dass „identity_provider“ nur für SAML SSO erforderlich ist.

Das Feld „identity_provider“ wird verwendet, um Benutzer, die sich über SSO in der Mitarbeiter-App einloggen, korrekt zuzuordnen. Den benötigten „alias“ für die Anfrage erhältst du von deiner Flip-Kontaktperson.

Die „user_id“ und der „username“ sind die Login-Informationen für Benutzer, die im Identitätsmanagement des Unternehmens konfiguriert sind.

Warum werden Benutzer nicht automatisch über SSO erstellt?

Wenn Benutzer automatisch erstellt werden, fehlen wichtige Informationen, z. B. welche Rolle die Benutzer in der App haben oder welchen Gruppen sie angehören.

Müssen alle Benutzer über die API synchronisiert werden?

Es ist nicht zwingend erforderlich, dass alle Benutzer über die API synchronisiert werden. Sie können auch in der Benutzerverwaltung, mit unserem Flip Syncer oder per Excel-Import erstellt werden. Dennoch empfehlen wir, besonders bei einer großen Anzahl von Benutzern, alle Benutzer einheitlich über die API zu erstellen, um manuelle Fehler zu vermeiden.

Benutzer können über die API mit dem Request „Create or update multiple users at once“ aktualisiert werden. Die Werte für die Felder „username“ und „external_id“ müssen ebenfalls gesendet werden. Der „username“ und die „external_id“ bestehender Benutzer können über den Request „Get all existing users“ ermittelt werden.

Wichtig: Benutzer, die in der App oder per Excel-Import erstellt wurden, haben keine external_id. Um sie über die API synchronisieren zu können, muss der „username“ im Request „Create or update multiple users at once“ für einen Benutzer gesendet werden. Der Benutzer muss auch eine „external_id“ erhalten.

Wie können Benutzer deaktiviert oder gelöscht werden?

Um einen Benutzer zu deaktivieren, muss das Feld „enabled“ im Request „Create or update multiple users at once“ auf false gesetzt werden. Sobald ein Benutzer über enabled = true reaktiviert wird, erhält er oder sie wieder Zugriff auf die Inhalte der App.

Benutzer können mit dem Request „Delete multiple users at once using their externalId“ gelöscht werden. Der Benutzer hat dann keinen Zugriff mehr auf die Inhalte der App.

Was kann ich tun, wenn ich einen oder mehrere Benutzer versehentlich gelöscht habe?

Benutzer, die versehentlich gelöscht wurden, können mit dem Request „Create or update multiple users at once“ wiederhergestellt werden, indem du ihre vorherige „external_id“ und „username“ angibst.

Wie können Channels über die API erstellt werden?

Beachte, dass „groups“ in der Dokumentation „channels“ bedeutet. Dies liegt daran, dass die entsprechende Funktionalität nach der Veröffentlichung der API umbenannt wurde.

Gruppen können über die API mit dem Request „Create or update multiple channels (previously groups) at once“ erstellt werden. Alle Felder, die als „required“ gekennzeichnet sind, müssen für jede Gruppe gesendet werden; Felder ohne das „required“-Attribut sind optional.

Wie können bestehende Channels über die API aktualisiert und befüllt werden?

Es kann vorkommen, dass Channels manuell über die Mitarbeiter-App oder den Excel-Import erstellt wurden und nachträglich mit Benutzern über die API gefüllt werden sollen. Dies kann in drei einfachen Schritten erfolgen. Wenn die Gruppen über die API erstellt wurden, reicht Schritt 3 aus.

1. Channels abfragen: In diesem Fall ist es zunächst erforderlich, die „group_id“ über den Request „Get all existing channels (previously groups)“ abzufragen. Alle Channels, die in der Antwort keine „external_id“ haben, wurden entweder manuell in der App, über Excel-Import oder über das Admin-Dashboard erstellt.
2. external_id zuweisen: Anschließend müssen diese Channels über den Request „Create or update multiple channels (previously groups) at once“ eine „external_id“ erhalten. Verwende dazu die Werte aus der vorherigen Anfrage für die Felder „name“ und „group_id“. Zusätzlich muss ein Wert für „external_id“ angegeben werden.
3. Benutzer zu Channels hinzufügen: Um die Benutzer zu einem Channel hinzuzufügen, sollten die „group_external_id“ dieses Channels und die entsprechende „group_role“ (die Rolle der Benutzer im Channel) im Feld „group_membership“ angegeben werden.

Wie können bestehende Channels gelöscht werden?

Channels können über den Request „Delete multiple channels (previously groups) at once“ gelöscht werden, indem die jeweilige „external_id“ angegeben wird.

Was ist der Unterschied zwischen „external_id“ und „group_id“ im Kontext von Channels?

Die „group_id“ ist eine interne ID, die von Flip automatisch erstellt wird.

Beim Erstellen einer Gruppe über die API ist die „external_id“, die vom Kunden zugewiesen wird, die eindeutige ID.

Um einen manuell erstellten Channel über die API bearbeitbar zu machen und Benutzer zu diesem Channel hinzuzufügen, muss zunächst die „group_id“ über den Request „Get all existing channels (previously groups)“ abgefragt werden. Anschließend ist es notwendig, diesem Channel eine „external_id“ und den Channelname über den Request „Create or update multiple channels (previously groups) at once“ zuzuweisen.