API SCIM
L’API SCIM de Wrike permet le provisionnement et la gestion automatisés des utilisateurs en synchronisant les données utilisateur depuis votre fournisseur d’identité. Utilisez-la pour créer, mettre à jour et désactiver des utilisateurs tout en conservant un contrôle centralisé sur les informations d’accès et d’identité.
|
Disponibilité : Legacy Enterprise.; Indisponibilité : Legacy Free, Legacy Professional, Legacy Business.; |
|
Disponibilité : Pinnacle, Apex. Indisponibilité : Free, Team, Business; |
Le System for Cross-domain Identity Management (SCIM) est une norme permettant d’automatiser l’échange d’informations d’identité utilisateur entre différents domaines d’identité ou systèmes informatiques. Wrike propose des solutions prêtes à l’emploi pour le provisionnement SCIM avec OKTA, OneLogin et Azure AD, détaillées dans les articles d’aide liés. Cette page traite du provisionnement SCIM personnalisé via l’API.
Il peut être utilisé pour :
-
Provisionner de nouveaux utilisateurs dans Wrike
-
Provisionner et mettre à jour les attributs utilisateur pris en charge
-
Provisionner et mettre à jour les attributs utilisateur personnalisés
-
Désactiver ou supprimer des utilisateurs dans Wrike
-
Créer et mettre à jour des groupes d’utilisateurs dans Wrike
-
Ajouter ou supprimer des appartenances à des groupes
-
Fonctionne uniquement avec un abonnement de niveau Legacy Enterprise, Pinnacle ou Apex.
-
La synchronisation est à sens unique : de l’IdP vers Wrike.
-
Les mots de passe des utilisateurs ne sont pas stockés dans Wrike. Si un utilisateur est créé via SCIM sur un compte sans SAML SSO, il devra utiliser la page de réinitialisation du mot de passe pour en créer un.
-
La recherche n’est prise en charge que par adresse e-mail.
-
Wrike utilise l’adresse e-mail comme nom d’utilisateur. Lors du provisionnement ou de l’intégration, Wrike recherchera une adresse e-mail valide dans userName ou emails à utiliser comme identifiant.
Note
Comme les méthodes de mise en œuvre de SCIM varient considérablement selon les fournisseurs d’identité (messages d’erreur, actions prises en charge ou non, etc.), les aspects spécifiques au fournisseur de l’utilisation et des messages d’erreur SCIM doivent être étudiés par vos administrateurs IdP en étroite collaboration avec eux. Le dépannage et le conseil sur les spécificités de l’implémentation SCIM chez différents fournisseurs d’identité ne relèvent pas du Wrike Customer Support scope of work.
-
Vous devez disposer d’un compte avec un abonnement Legacy Enterprise, Pinnacle ou Apex et être Administrateur avec les droits suivants activés : « modifier les noms et les e-mails, ajouter/supprimer des personnes de groupes, exporter une liste d’utilisateurs, désactiver et supprimer des comptes utilisateur individuels », « Configurer les paramètres de sécurité avancés » et « Accorder/révoquer les droits d’administrateur ».
-
Add approved domains. Seuls les utilisateurs issus de domaines approuvés seront automatiquement provisionnés dans Wrike.
-
Générez un jeton API permanent.
-
Dans Applications & intégrations, récupérez l’URL SCIM de votre compte depuis l’onglet SCIM de la carte OKTA, OneLogin ou Azure AD.
-
Vous pouvez utiliser Postman pour profiter de notre environnement et de notre collection d’appels prédéfinis. Pour préparer un environnement Postman, téléchargez et importez :
-
Collection d’appels SCIM Wrike pour Postman : Wrike SCIM.postman_collection.json
-
Téléchargez et importez l’environnement Wrike SCIM, ajoutez votre URL de base + votre jeton permanent : Wrike_SCIM_API.postman_environment.json
-
. Utilisateurs
-
Lister les utilisateurs intégrés - GET {{base_url}}/Users - renvoie un JSON contenant les informations sur les utilisateurs du compte déjà intégrés via SCIM. Il s’agit des utilisateurs créés par invitation puis associés via l’appel POST /Users, AINSI que des utilisateurs provisionnés directement via SCIM. Si vous avez créé des utilisateurs manuellement et que vous ne les avez pas encore intégrés avec l’appel n° 2, ils n’apparaîtront pas dans le JSON.
-
Obtenir un utilisateur intégré - GET {{base_url}}/Users/ - ajoutez l’ID de l’utilisateur pour recevoir un JSON contenant les informations sur cet utilisateur, par exemple GET {{base_url}}/Users/KUAH4WFR où KUAH4WFR est l’ID API de l’utilisateur.
-
Rechercher des utilisateurs intégrés avec le filtre eq - GET {{base_url}}/Users?filter=userName eq \"jerome.chef@scim.test\" - recherche l’utilisateur par adresse e-mail complète principale.
-
-
Création d’utilisateur - POST {{base_url}}/Users + corps de requête correctement formaté (vous trouverez un exemple de corps de requête avec explications ci-dessous) - crée un utilisateur avec les attributs spécifiés dans le corps de la requête.
-
Remplacement des attributs utilisateur - PUT {{base_url}}/Users/{{user_id}} + corps de requête correctement formaté (exemple ci-dessous) - réécrit tous les attributs utilisateur selon le corps de la requête. Cet appel peut être utilisé pour mettre à jour le type d’utilisateur et désactiver/activer un utilisateur.
-
Patch d’attributs utilisateur - PATCH {{base_url}}/Users/{{user_id}} + corps de requête correctement formaté (exemple ci-dessous) - similaire, à la différence que le corps de la requête contient uniquement les attributs à mettre à jour et leurs nouvelles valeurs.
-
Suppression d’utilisateur - DELETE {{base_url}}/Users/{{user_id}}.
Attributs utilisateur personnalisés
-
Les attributs utilisateur personnalisés peuvent être provisionnés et mis à jour via l’extension SCIM de Wrike dans le cadre des appels POST /Users, PUT /Users/{{user_id}} et PATCH /Users/{{user_id}}.
Groupes
-
Lister les groupes - GET {{base_url}}/Groups - renvoie un JSON contenant les informations sur les groupes d’utilisateurs Wrike provisionnés.
-
Obtenir un groupe - GET {{base_url}}/Groups/{{group_id}} - renvoie un JSON contenant les informations sur ce groupe.
-
Création de groupe - POST {{base_url}}/Groups + corps de requête correctement formaté - crée un groupe d’utilisateurs Wrike.
-
Patch de groupe - PATCH {{base_url}}/Groups/{{group_id}} + corps de requête correctement formaté - met à jour les attributs du groupe et les modifications de membres.
-
Suppression de groupe - DELETE {{base_url}}/Groups/{{group_id}}.
Voici un exemple de corps de requête pour créer un utilisateur, lier un utilisateur existant ou mettre à jour des attributs utilisateur :
*userName, e-mails principale et secondaires :
-
Le champ userName est obligatoire.
-
Les e-mails (principaux et secondaires) sont facultatifs ; vous pouvez ajouter autant d’e-mails que nécessaire dans ce bloc.
-
Si aucun e-mail principal N’EST fourni dans le corps de la requête, userName est ajouté comme adresse e-mail principale de l’utilisateur dans Wrike.
-
Si un e-mail principal EST fourni dans le corps de la requête, celui-ci est utilisé comme adresse e-mail principale de l’utilisateur dans Wrike.
-
S’il y a des e-mails dans emails et qu’aucun n’est marqué comme principal, userName est ajouté comme adresse principale de l’utilisateur dans Wrike et les autres sont ajoutés comme e-mails secondaires.
**Langues disponibles et leur signification :
Voici un exemple de corps de requête pour patcher les attributs utilisateur :
L’intégration Wrike-SCIM permet de définir les types d’utilisateur des utilisateurs liés via SCIM lors des requêtes de provisionnement ou de mise à jour grâce au paramètre wrikeUserType.
Les valeurs acceptées pour l’attribut wrikeUserType correspondant aux types d’utilisateur par défaut sont « Regular », « External », « Collaborator », « Viewer » et « Contributor » (avec ou sans majuscule).
Remarque
« Viewer » et « Contributor » sont acceptés si ces types d’utilisateur sont activés dans votre compte.
La liaison avec les types d’utilisateur par défaut reste active même si ces types ont été renommés/modifiés (par exemple, si « Regular user » a été renommé en External, une requête contenant la valeur « Regular » sera toujours associée à ce même type d’utilisateur).
Les valeurs des ID des types d’utilisateur par défaut sont les suivantes :
-
Owner: -1
-
Admin: -2
-
Regular: -3
-
External: -4
-
Collaborator: -5
-
Viewer: -8
-
Contributor: -10
Note
Les types d’utilisateur Viewer et Contributor peuvent être ou non activés dans votre compte. En cas de doute, veuillez contacter votre représentant Customer Success pour vérifier s’ils sont activés.
Une méthode plus fiable et plus robuste consiste à faire référence aux types d’utilisateur via leurs UID d’API ; privilégiez donc toujours cette méthode. Les UID peuvent être récupérés à l’aide de l’une des méthodes suivantes :
-
avec la méthode GET /user_types dans l’API Wrike.
-
à partir de la réponse des méthodes CREATE, GET ou PATCH pour les utilisateurs existants.
-
L’équipe d’assistance Wrike peut vous fournir les UID des types d’utilisateur de votre compte sur demande du propriétaire ou d’un administrateur du compte.
Important
Veuillez noter que l’attribut name.formatted ne peut pas être patché avec la méthode PATCH. Sa valeur est générée automatiquement à partir des attributs utilisateur name.familyName et name.givenName.
Wrike prend en charge les champs personnalisés au niveau utilisateur. Ils peuvent être provisionnés via SCIM en utilisant une extension SCIM personnalisée :
Chaque champ personnalisé d’utilisateur est référencé comme suit :
Exemple :
Le provisionnement de groupes permet :
-
Création automatique de groupes d’utilisateurs Wrike à partir des groupes définis dans l’IdP
-
Ajout et suppression de membres dans le groupe
-
Suppression du groupe lorsqu’il est supprimé dans l’IdP
-
Mises à jour incrémentielles continues
Les groupes sont synchronisés via le point de terminaison SCIM /Groups.