Le portail développeur de l’API Workleap présente tous les points de terminaison de l’API Workleap, ainsi que leurs attributs, la structure des requêtes et les réponses. Vous pouvez aussi utiliser ce portail pour générer et modifier des charges utiles (payloads) pour chaque point de terminaison et envoyer des requêtes.
Cet article explique comment créer un nouvel utilisateur dans le portail développeur via le point de terminaison POST - Créer un utilisateur. Il a pour but de vous aider à comprendre comment utiliser le portail développeur et envoyer des requêtes à n’importe quel point de terminaison de l’API Workleap.
Créer un utilisateur via le portail développeur de l’API Workleap
Pour créer un utilisateur via l’API Workleap, vous devez envoyer une requête au point de terminaison Créer un utilisateur. Ouvrez la page du point de terminaison POST - Créer un utilisateur dans notre portail développeur pour plus de détails.
Commencez par trouver la section Corps de la requête (Request body). Vous y verrez tous les attributs que vous pouvez inclure dans votre charge utile. Les attributs définissent les types de données que l’API s’attend à recevoir dans les requêtes.
Dans la section Corps de la requête, vous verrez que les attributs pour les requêtes POST Créer un utilisateur sont les suivants :
nametitleemailsphoneNumbersurn:workleap:params:scim:schemas:extension:user:2.0:User
À côté de chaque nom d’attribut, vous trouverez son statut Requis, son Type, et sa Description.
Requis : Indique si un attribut est obligatoire. Si un paramètre requis est absent de la charge utile, vous recevrez une réponse d’erreur.
Type : Montre le type de valeur associé à l’attribut.
Description : Décrit en langage clair l’objectif de l’attribut.
Dans la colonne Requis, vous verrez qu’il n’y a qu’un seul attribut requis pour les requêtes POST de création d’utilisateur : emails. Cela signifie que les charges utiles envoyées à ce point de terminaison doivent au minimum inclure une valeur pour cet attribut. Sinon, elles seront rejetées.
L’attribut emails est décrit comme suit dans la colonne Description :
Une liste d’adresses courriel associées à l’utilisateur. La première est considérée comme l’adresse principale, les suivantes comme des adresses personnelles.
Et urn:workleap:params:scim:schemas:extension:user:2.0:User ? Il s’agit d’un exemple d’extension de schéma personnalisé, c’est-à-dire un regroupement personnalisé d’attributs.
Pour consulter les attributs qui composent cette extension, allez à l’exemple de charge utile JSON par défaut, sous la liste des attributs.
Voici la section de la charge utile à analyser
Voici la section de la charge utile à analyser
"urn:workleap:params:scim:schemas:extension:user:2.0:User": { "productAssignations": ["string"], "bio": "string", "executiveAssignations": ["string"], "collaboratorAssignations": ["string"], "employeeIdentifier": "string", "inviteOnMemberCreation": true }Cette extension de schéma personnalisé est composée des attributs suivants :
productAssignationsbioexecutiveAssignationscollaboratorAssignationsemployeeIdentifierinviteOnMemberCreation
Pour en savoir plus sur ces attributs, faites défiler la page dans le portail développeur ou utilisez Ctrl/Cmd + F pour rechercher la section WorkleapUserRequestExtension. Vous y trouverez un tableau contenant les colonnes Nom, Requis, Type et Description :
Nom | Requis | Type | Description |
| false | string[] | Un tableau de codes produits à 3 lettres indiquant à quels produits Workleap l’utilisateur a été assigné. Les codes autorisés sont : Officevibe (wov), Onboarding (onb), LMS (lms), Skills (sks), Pingboard (pbd), Performance (wpm) et Workleap AI (wai). |
| false | string | La biographie de l’utilisateur. Il s’agit d’une courte description. |
| false | string[] | Un tableau de codes produits à 3 lettres indiquant à quels produits Workleap l’utilisateur a été assigné en tant que dirigeant. |
| false | string[] | Un tableau de codes produits à 3 lettres indiquant à quels produits Workleap l’utilisateur a été assigné en tant que contributeur. |
| false | string | Un champ pour stocker un identifiant employé personnalisé. |
| false | boolean | Indique si l’utilisateur doit être invité lors de la création du membre. |
La colonne Description indique les valeurs attendues pour chaque attribut. Si votre charge utile contient des valeurs ou formats différents de ceux décrits dans le portail, la requête échouera.
Effets des attributs vides
Pour la plupart des attributs non requis, si le champ est laissé vide dans la charge utile, cette donnée n’est simplement pas transmise à Workleap (aucun changement pour ces attributs).
Cependant, certains attributs comme productAssignations, executiveAssignations et collaboratorAssignations sont liés aux rôles et accès aux produits. Dans ce cas, les charges utiles indiquent ce que le statut de l’utilisateur doit être après le traitement.
Par exemple, si vous envoyez une requête PUT pour modifier un utilisateur ayant accès à Officevibe, Performance et LMS, et que vous laissez le champ productAssignations vide, l’API supprimera tous ses accès produits.
Générer une clé API
Toutes les requêtes envoyées à l’API Workleap nécessitent une clé API générée depuis votre compte Workleap pour validation.
Pour générer une clé API :
Connectez-vous à Workleap et ouvrez Paramètres.
Sélectionnez Provisioning dans le menu latéral.
Cliquez sur Connecter/Afficher les paramètres à côté de Provisionnement API.
Cliquez sur Créer une clé sous Clés API de gestion de l’organisation.
Copiez la clé API et conservez-la en lieu sûr.
Important : La clé API complète est affichée une seule fois lors de sa création et ne peut pas être récupérée si vous la perdez.
Ajouter une clé API à un en-tête de requête
Une clé API doit être incluse dans l’en-tête de toutes les charges utiles envoyées à l’API Workleap.
Pour ajouter une clé API dans le portail développeur :
Ouvrez le portail développeur de l’API Workleap.
Sélectionnez un point de terminaison dans la liste à gauche.
Cliquez sur le bouton Essayer.
Trouvez
workleap-subscription-keydans la section Headers*.Copiez-collez votre clé API dans le champ valeur à côté de
workleap-subscription-key.
*Avertissement : Ne collez pas la clé API dans le champ subscription key sous la section Authorization.
Créer une charge utile
Vous pouvez utiliser le portail développeur de l’API Workleap pour générer des charges utiles formatées pour chaque point de terminaison. Pour ce faire :
Ouvrez le portail développeur de l’API Workleap.
Sélectionnez un point de terminaison dans la liste à gauche.
Cliquez sur Essayer.
Ajoutez votre clé API à
workleap-subscription-keydans Headers (voir section précédente).Repérez la section Body pour accéder à une charge utile préformatée et modifiable.
Ajoutez les valeurs nécessaires pour chaque attribut. Remplacez simplement le type par la valeur souhaitée.
Assurez-vous que tous les attributs requis ont une valeur.
La charge utile générée s’affiche en bas de l’interface dans la section Requête HTTP. Elle se met à jour automatiquement lorsque vous modifiez les sections ci-dessus.
Envoyer votre requête
Une fois toutes les valeurs ajoutées aux attributs souhaités, vous pouvez cliquer sur Envoyer pour soumettre votre requête. L’API Workleap vous enverra ensuite une réponse (voir section suivante).
Remarque : Si vous souhaitez utiliser cette charge utile dans un autre outil API, cliquez sur Copier pour la copier dans votre presse-papiers.
Réponses
Toutes les requêtes API reçoivent une réponse indiquant si l’action demandée a réussi ou échoué. En cas d’échec, la réponse explique pourquoi.
Dans le portail développeur, vous trouverez une liste des codes de réponse pour chaque point de terminaison. Pour les requêtes POST - Créer un utilisateur, le code de réponse en cas de succès est 201.
Pour les réponses 201 (Créé), l’API Workleap renvoie une charge utile contenant l’état actuel de l’utilisateur créé. Elle peut ressembler à ceci :
Exemple de réponse 201 (Créé)
Exemple de réponse 201 (Créé)
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User", "urn:workleap:params:scim:schemas:extension:user:2.0:User"],
"userName": null,
"name": {
"givenName": "happy. gilmore",
"familyName": ""
},
"displayName": "happy. gilmore",
"title": "",
"emails": [{
"value": "happy.gilmore@yourcompany.com",
"type": "Work",
"primary": true
}],
"phoneNumbers": [],
"preferredLanguage": "en-US",
"active": false,
"urn:workleap:params:scim:schemas:extension:user:2.0:User": {
"imageUrl": null,
"imageUrls": {},
"isTeamManager": false,
"isOrganizationAdmin": false,
"isReportingManager": false,
"memberState": "Created",
"timeZone": "UTC",
"assignedProducts": [],
"preferredLanguages": ["en-US"],
"bio": "",
"executiveAssignations": [],
"collaboratorAssignations": [],
"employeeIdentifier": ""
},
"id": "615f99e1-18a9-47ca-988f-d47a9c14dfbd",
"meta": {
"resourceType": "User",
"created": "2025-08-14T00:17:32.313+00:00",
"lastModified": null,
"version": "1"
}
}Notez que l’utilisateur créé dans l’exemple ci-dessus possède maintenant la valeur id 615f99e1-18a9-47ca-988f-d47a9c14dfbd. Les valeurs id sont générées et attribuées lors de la création d’un utilisateur. Elles sont ensuite utilisées pour toutes les actions de gestion d’utilisateur futures.
Remarque : Pour plusieurs points de terminaison liés à la gestion des utilisateurs dans l’API Workleap, l’attribut id est requis (par exemple, PUT - Mettre à jour un utilisateur).