SCIM-API
Die SCIM-API in Wrike ermöglicht die automatisierte Bereitstellung und Verwaltung von Nutzern, indem sie Nutzerdaten aus Ihrem Identity Provider synchronisiert. Verwenden Sie sie, um Nutzer zu erstellen, zu aktualisieren und zu deaktivieren und dabei die zentrale Kontrolle über Zugriffs- und Identitätsinformationen zu behalten.
|
Availability: Legacy Enterprise.; Unavailability: Legacy Free, Legacy Professional, Legacy Business.; |
|
Availability: Pinnacle, Apex. ; Unavailability: Free, Team, Business; |
Das System für domänenübergreifendes Identitätsmanagement (SCIM) ist ein Standard zur Automatisierung des Austauschs von Nutzeridentitätsinformationen zwischen Identitätsdomänen bzw. IT-Systemen. Es gibt Out-of-the-Box-Lösungen für die SCIM-Bereitstellung in Wrike mit OKTA, OneLogin und Azure AD, die in den verlinkten Hilfeartikeln ausführlich beschrieben sind. Diese Seite behandelt die benutzerdefinierte SCIM-Bereitstellung über die API.
Damit können Sie:
-
Neue Nutzer in Wrike bereitstellen
-
Unterstützte Nutzerattribute bereitstellen und aktualisieren
-
Benutzerdefinierte Nutzerattribute bereitstellen und aktualisieren
-
Nutzer in Wrike deaktivieren oder löschen
-
Nutzergruppen in Wrike erstellen und aktualisieren
-
Gruppenmitgliedschaften hinzufügen oder entfernen
-
Funktioniert nur mit den Tarifen Legacy Enterprise, Pinnacle und Apex.
-
Die Synchronisierung erfolgt nur in eine Richtung – vom IdP zu Wrike.
-
Nutzerpasswörter werden nicht in Wrike gespeichert. Wenn ein Nutzer per SCIM in einem Konto ohne SAML-SSO erstellt wird, muss der Nutzer die Seite zum Zurücksetzen des Passworts verwenden, um ein Passwort anzulegen.
-
Die Suche wird nur nach E-Mail-Adresse unterstützt.
-
Wrike verwendet die E-Mail-Adresse als Benutzernamen. Bei der Bereitstellung oder Integration sucht Wrike nach einer gültigen E-Mail-Adresse in userName oder emails, um diese als Login zu verwenden.
Hinweis
Da sich die SCIM-Implementierung bei verschiedenen Identity Providern (z. B. hinsichtlich Fehlermeldungen und unterstützter bzw. nicht unterstützter Aktionen) erheblich unterscheidet, sollten IdP-spezifische Aspekte der SCIM-Funktionen und Fehlermeldungen von Ihren IdP-Administrator*innen untersucht werden – in enger Zusammenarbeit mit diesen. Die Fehlerbehebung und Beratung zu spezifischen SCIM-Implementierungen bei verschiedenen Identity Providern liegt außerhalb des Leistungsumfangs des Wrike Customer Support.
-
Sie müssen ein Konto mit einer Legacy Enterprise-, Pinnacle- oder Apex-Subscription besitzen und Administrator*in sein mit den Rechten „Namen und E-Mails bearbeiten, Personen zu Gruppen hinzufügen/entfernen, Benutzerliste exportieren, einzelne Nutzerkonten deaktivieren und löschen“, „Erweiterte Sicherheitseinstellungen konfigurieren“ sowie „Administratorrechte gewähren/entziehen“.
-
Add approved domains. Nur Nutzer aus genehmigten Domains werden automatisch in Wrike bereitgestellt.
-
Ein dauerhaftes Token generieren.
-
Unter „Apps & Integrationen“ finden Sie die SCIM-URL Ihres Kontos auf der SCIM-Registerkarte der OKTA-, OneLogin- oder Azure-AD-Karte.
-
Sie können Postman verwenden, um unsere vorkonfigurierte Umgebung und Aufrufsammlung zu nutzen. Um eine Postman-Umgebung vorzubereiten, laden Sie Folgendes herunter und importieren Sie es:
-
Wrike-SCIM-Aufrufsammlung für Postman: Wrike SCIM.postman_collection.json
-
Laden Sie die Wrike-SCIM-Umgebung herunter und importieren Sie sie, fügen Sie anschließend Ihre Basis-URL + dauerhaftes Token hinzu: Wrike_SCIM_API.postman_environment.json
-
. Nutzer
-
Integrierte Nutzer auflisten – GET {{base_url}}/Users – gibt ein JSON mit Informationen über vorhandene Konto-Nutzer zurück, die per SCIM integriert sind. Dabei handelt es sich um Nutzer, die per Einladung erstellt und anschließend mit dem Aufruf POST /Users verknüpft wurden, SOWIE um Nutzer, die direkt über SCIM bereitgestellt wurden. Wenn Sie einige Nutzer manuell erstellt und sie noch nicht mit Aufruf Nr. 2 integriert haben, erscheinen sie nicht im JSON.
-
Integrierten Nutzer abrufen – GET {{base_url}}/Users/ – fügen Sie die Nutzer-ID hinzu, um ein JSON mit den Informationen zu diesem Nutzer zu erhalten, z. B. GET {{base_url}}/Users/KUAH4WFR, wobei KUAH4WFR die API-ID des Nutzers ist.
-
Integrierte Nutzer mit eq-Filter suchen – GET {{base_url}}/Users?filter=userName eq "jerome.chef@scim.test" – sucht den Nutzer anhand der vollständigen primären E-Mail-Adresse.
-
-
Nutzererstellung – POST {{base_url}}/Users + korrekt formatierter Request-Body (eine beispielhafte Anforderung mit Erläuterung finden Sie unten) – erstellt einen Nutzer mit den im Request-Body angegebenen Attributen.
-
Ersetzen von Nutzerattributen – PUT {{base_url}}/Users/{{user_id}} + ein korrekt formatierter Request-Body (ein Beispiel finden Sie unten) – überschreibt alle Nutzerattribute entsprechend dem Request-Body. Mit diesem Aufruf können Sie den Nutzer-Typ aktualisieren und den Nutzer deaktivieren/aktivieren.
-
Nutzerattribut-Patch – PATCH {{base_url}}/Users/{{user_id}} + ein korrekt formatierter Request-Body (Beispiel unten) – fast dasselbe, jedoch enthält der Request-Body nur die zu aktualisierenden Attribute und deren neue Werte.
-
Nutzerlöschung – DELETE {{base_url}}/Users/{{user_id}}.
Benutzerdefinierte Nutzerattribute
-
Benutzerdefinierte Nutzerattribute können über die Wrike-SCIM-Erweiterung als Teil von POST /Users, PUT /Users/{{user_id}} und PATCH /Users/{{user_id}} bereitgestellt und aktualisiert werden.
Gruppen
-
Gruppen auflisten – GET {{base_url}}/Groups – gibt ein JSON mit Informationen über bereitgestellte Wrike-Nutzergruppen zurück.
-
Gruppe abrufen – GET {{base_url}}/Groups/{{group_id}} – gibt ein JSON mit Informationen zu dieser Gruppe zurück.
-
Gruppe erstellen – POST {{base_url}}/Groups + korrekt formatierter Request-Body – erstellt eine Wrike-Nutzergruppe.
-
Gruppen-Patch – PATCH {{base_url}}/Groups/{{group_id}} + ein korrekt formatierter Request-Body – aktualisiert Gruppenattribute und Mitgliederänderungen.
-
Gruppenlöschung – DELETE {{base_url}}/Groups/{{group_id}}.
Dies ist ein Beispiel-Request-Body zum Erstellen eines Nutzers / Verknüpfen eines vorhandenen Nutzers / Aktualisieren von Nutzerattributen:
*userName, primäre und sekundäre E-Mail-Adressen:
-
userName-Feld ist obligatorisch.
-
E-Mails (primär und nicht primär) sind optional; in diesem Block können beliebig viele E-Mails enthalten sein.
-
Wenn keine primäre E-Mail im Request-Body vorhanden ist, wird userName als primäre E-Mail-Adresse des Nutzers in Wrike übernommen.
-
Wenn eine primäre E-Mail vorhanden ist, wird diese als primäre E-Mail-Adresse des Nutzers in Wrike verwendet.
-
Befinden sich E-Mails im Feld emails und ist keine davon als primär gekennzeichnet, wird userName als primäre Adresse des Nutzers in Wrike verwendet und die übrigen werden als sekundäre E-Mails hinzugefügt.
**Verfügbare Gebietsschemas und deren Bezeichnungen:
Hier ist ein Beispiel-Request-Body zum Patchen von Nutzerattributen:
Die Wrike–SCIM-Integration ermöglicht es, mithilfe des Parameters wrikeUserType den Nutzer-Typ von SCIM-verknüpften Nutzern bei Bereitstellungs- oder Aktualisierungsanfragen festzulegen.
Die zulässigen Werte für das Attribut wrikeUserType, die den Standard-Nutzer-Typen entsprechen, sind „Regular“, „External“, „Collaborator“, „Viewer“ und „Contributor“ (Groß-/Kleinschreibung beliebig).
Notiz
"Viewer" und "Contributor" werden akzeptiert, wenn diese Nutzer-Typen in Ihrem Konto aktiviert sind.
Die Verknüpfung zu den Standard-Nutzer-Typen bleibt auch dann bestehen, wenn diese umbenannt/geändert wurden (z. B. wenn "Regular user" in "External" umbenannt wurde – eine Anfrage mit dem Wert „Regular“ wird dennoch mit demselben Nutzer-Typ verknüpft).
Die Werte für die IDs der Standard-Nutzer-Typen lauten wie folgt:
-
Owner: -1
-
Admin: -2
-
Regular: -3
-
External: -4
-
Collaborator: -5
-
Viewer: -8
-
Contributor: -10
Anmerkung
Die Nutzer-Typen Viewer und Contributor sind möglicherweise in Ihrem Konto aktiviert oder deaktiviert. Wenn Sie unsicher sind, wenden Sie sich bitte an Ihre Customer-Success-Ansprechperson, um zu klären, ob sie aktiviert sind.
Eine robustere und verlässlichere Methode besteht darin, auf Nutzer-Typen anhand ihrer API-UIDs zu verweisen – bitte verwenden Sie daher nach Möglichkeit immer diese Methode. UIDs können auf eine der folgenden Arten abgerufen werden:
-
mit der Methode GET /user_types in der Wrike API.
-
über die Antwort der CREATE-, GET- oder PATCH-Methoden für vorhandene Nutzer.
-
Das Wrike Support-Team kann Ihnen auf Anfrage des Konto-Eigentümers oder Admins die UIDs der Nutzer-Typen Ihres Kontos bereitstellen.
Wichtig
Beachten Sie, dass das Attribut name.formatted nicht per PATCH-Methode geändert werden kann. Sein Wert wird automatisch aus den Nutzerattributen name.familyName und name.givenName generiert.
Wrike unterstützt Benutzerbezogene benutzerdefinierte Felder. Diese können über SCIM mittels einer benutzerdefinierten SCIM-Erweiterung bereitgestellt werden:
Jedes benutzerdefinierte Nutzerfeld wird referenziert als:
Beispiel:
Die Gruppenbereitstellung ermöglicht:
-
Automatische Erstellung von Wrike-Nutzergruppen basierend auf im IdP definierten Gruppen
-
Hinzufügen und Entfernen von Mitgliedern aus der Gruppe
-
Löschen der Gruppe, wenn sie im IdP entfernt wurde
-
Fortlaufende Delta-Updates
Gruppen werden über den SCIM-Endpunkt /Groups synchronisiert.