Tutorial: Konfigurieren von Documo für die automatische Benutzerbereitstellung
In diesem Tutorial werden die Schritte beschrieben, die Sie sowohl in Documo als auch in Microsoft Entra ID ausführen müssen, um die automatische Benutzerbereitstellung zu konfigurieren. Nach der Konfiguration stellt Microsoft Entra ID mithilfe des Microsoft Entra-Bereitstellungsdienstes automatisch Benutzer und/oder Gruppen in Documo bereit bzw. hebt die Bereitstellung auf. Wichtige Details zum Zweck und zur Funktionsweise dieses Diensts sowie häufig gestellte Fragen finden Sie unter Automatisieren der Bereitstellung und Bereitstellungsaufhebung von Benutzer*innen für SaaS-Anwendungen mit Microsoft Entra ID.
Unterstützte Funktionen
- Erstellen von Benutzern in Documo
- Entfernen von Benutzern aus Documo, wenn diese keinen Zugriff mehr benötigen
- Synchronisieren von Benutzerattributen zwischen Microsoft Entra ID und Documo
- Einmaliges Anmelden bei Documo (empfohlen)
Voraussetzungen
Das diesem Tutorial zu Grunde liegende Szenario setzt voraus, dass Sie bereits über die folgenden Voraussetzungen verfügen:
- Ein Microsoft Entra-Mandant
- Eine der folgenden Rollen: Anwendungsadministrator, Cloudanwendungsadministrator oder Anwendungsbesitzer
- Ein Documo-Konto mit API-Zugriff
- Ein Benutzerkonto in Documo mit Administratorberechtigungen
Schritt 1: Planen der Bereitstellung
- Erfahren Sie, wie der Bereitstellungsdienst funktioniert.
- Bestimmen Sie, wer in den Bereitstellungsbereich einbezogen werden soll.
- Legen Sie fest, welche Daten zwischen Microsoft Entra ID und Documo zugeordnet werden sollen.
Schritt 2: Konfigurieren von Documo zur Unterstützung der Bereitstellung mit Microsoft Entra ID
- Generieren Sie einen API-Schlüssel, der für die Microsoft Entra-Bereitstellung verwendet werden soll.
- Suchen Sie die API-URL, und merken Sie sich diese. Die Standard-API-URL lautet
https://api.documo.com. Wenn Sie über eine benutzerdefinierte Documo-API-Domäne verfügen, können Sie auf der Seite mit den Documo-Brandingeinstellungen auf der Domänenregisterkarte darauf verweisen.
Schritt 3: Hinzufügen von Documo aus dem Microsoft Entra Anwendungskatalog
Fügen Sie Documo aus dem Microsoft Entra-Anwendungskatalog hinzu, um mit dem Verwalten der Bereitstellung in Documo zu beginnen. Wenn Sie Documo bereits für einmaliges Anmelden eingerichtet haben, können Sie die gleiche Anwendung verwenden. Es ist jedoch empfehlenswert, beim erstmaligen Testen der Integration eine separate App zu erstellen. Hier erfahren Sie mehr über das Hinzufügen einer Anwendung aus dem Katalog.
Schritt 4: Definieren der Benutzer für den Bereitstellungsbereich
Mit dem Microsoft Entra-Bereitstellungsdienst können Sie anhand der Zuweisung zur Anwendung und/oder anhand von Attributen für Benutzer*innen bzw. die Gruppe festlegen, wer in die Bereitstellung einbezogen werden soll. Wenn Sie sich dafür entscheiden, anhand der Zuweisung festzulegen, wer für Ihre App bereitgestellt werden soll, können Sie der Anwendung mithilfe der folgenden Schritte Benutzer und Gruppen zuweisen. Wenn Sie allein anhand der Attribute des Benutzers oder der Gruppe auswählen möchten, wer bereitgestellt wird, können Sie einen hier beschriebenen Bereichsfilter verwenden.
Fangen Sie klein an. Testen Sie die Bereitstellung mit einer kleinen Gruppe von Benutzern und Gruppen, bevor Sie sie für alle freigeben. Wenn der Bereitstellungsbereich auf zugewiesene Benutzer und Gruppen festgelegt ist, können Sie dies durch Zuweisen von einem oder zwei Benutzern oder Gruppen zur App kontrollieren. Ist der Bereich auf alle Benutzer und Gruppen festgelegt, können Sie einen attributbasierten Bereichsfilter angeben.
Wenn Sie zusätzliche Rollen benötigen, können Sie das Anwendungsmanifest so ändern, dass neue Rollen hinzugefügt werden.
Schritt 5: Konfigurieren der automatischen Benutzerbereitstellung in Documo
In diesem Abschnitt werden die Schritte zum Konfigurieren des Microsoft Entra-Bereitstellungsdiensts zum Erstellen, Aktualisieren und Deaktivieren von Benutzer*innen und/oder Gruppen in Documo auf der Grundlage von Benutzer- bzw. Gruppenzuweisungen in Microsoft Entra ID erläutert.
So konfigurieren Sie die automatische Benutzerbereitstellung für Documo in Microsoft Entra ID:
Melden Sie sich beim Microsoft Entra Admin Center mindestens als Cloudanwendungsadministrator an.
Navigieren Sie zu Identität>Anwendungen>Unternehmensanwendungen.
Wählen Sie in der Anwendungsliste den Eintrag Documo aus.
Wählen Sie die Registerkarte Bereitstellung.
Legen Sie den Bereitstellungsmodus auf Automatisch fest.
Geben Sie im Abschnitt Administratoranmeldeinformationen die Werte für Mandanten-URL und Geheimes Token für Documo ein.
Die Mandanten-URL ist die in Schritt 2 vorbereitete API-URL, an deren Ende
/scim/v2angefügt wird. Der Wert für URLs ohne benutzerdefinierte Domänen musshttps://api.documo.com/scim/v2lauten.Kopieren Sie den in Schritt 2 vorbereiteten API-Schlüssel, und fügen Sie ihn in das Feld Geheimes Token ein. Klicken Sie auf Verbindung testen, um sicherzustellen, dass Microsoft Entra ID eine Verbindung mit Documo herstellen kann. Vergewissern Sie sich bei einem Verbindungsfehler, dass Ihr Documo-Konto über Administratorberechtigungen verfügt, und wiederholen Sie den Vorgang.
Geben Sie im Feld Benachrichtigungs-E-Mail die E-Mail-Adresse einer Person oder Gruppe ein, die Benachrichtigungen zu Bereitstellungsfehlern erhalten soll, und aktivieren Sie das Kontrollkästchen Bei Fehler E-Mail-Benachrichtigung senden.
Wählen Sie Speichern.
Wählen Sie im Abschnitt Zuordnungen die Option Synchronize Microsoft Entra-Benutzer mit Documo synchronisieren aus.
Überprüfen Sie im Abschnitt Attributzuordnungen die Benutzerattribute, die von Microsoft Entra ID mit Documo synchronisiert werden. Mit den als übereinstimmende Eigenschaften ausgewählten Attributen werden die Benutzerkonten in Documo bei Updatevorgängen abgeglichen. Wenn Sie das übereinstimmende Zielattribut ändern möchten, müssen Sie sicherstellen, dass die Documo-API das Filtern von Benutzern anhand dieses Attributs unterstützt. Wählen Sie die Schaltfläche Speichern, um alle Änderungen zu übernehmen.
Attribut type Unterstützung für das Filtern userName String ✓ aktiv Boolean name.givenName String name.familyName String roles[primary eq "True"].value String Wenn Sie Bereichsfilter konfigurieren möchten, lesen Sie die Anweisungen unter Attributbasierte Anwendungsbereitstellung mit Bereichsfiltern.
Um den Microsoft Entra-Bereitstellungsdienst für Documo zu aktivieren, ändern Sie den Bereitstellungsstatus im Abschnitt Einstellungen zu Ein.
Legen Sie die Benutzer und/oder Gruppen fest, die in Documo bereitgestellt werden sollen. Wählen Sie dazu im Abschnitt Einstellungen unter Bereich die gewünschten Werte aus.
Wenn Sie fertig sind, klicken Sie auf Speichern.
Durch diesen Vorgang wird der erstmalige Synchronisierungszyklus für alle Benutzer und Gruppen gestartet, die im Abschnitt Einstellungen unter Bereich definiert wurden. Der erste Zyklus dauert länger als nachfolgende Zyklen, die ungefähr alle 40 Minuten erfolgen, solange der Microsoft Entra-Bereitstellungsdienst ausgeführt wird.
Schritt 6: Überwachen der Bereitstellung
Nachdem Sie die Bereitstellung konfiguriert haben, können Sie mit den folgenden Ressourcen die Bereitstellung überwachen:
- Mithilfe der Bereitstellungsprotokolle können Sie ermitteln, welche Benutzer erfolgreich bzw. nicht erfolgreich bereitgestellt wurden.
- Anhand der Fortschrittsleiste können Sie den Status des Bereitstellungszyklus überprüfen und den Fortschritt der Bereitstellung verfolgen.
- Wenn sich die Bereitstellungskonfiguration in einem fehlerhaften Zustand zu befinden scheint, wird die Anwendung unter Quarantäne gestellt. Weitere Informationen zu den verschiedenen Quarantänestatus finden Sie hier.
Weitere Ressourcen
- Verwalten der Benutzerkontobereitstellung für Unternehmens-Apps
- Was ist Anwendungszugriff und einmaliges Anmelden mit Microsoft Entra ID?