Importer des utilisateurs
Créer jusqu'à 500 utilisateurs d'un client à partir d'un fichier CSV avec l'API publique, et savoir ce que l'import ne fait pas.
- Required access
- Niveau Administrateur client et droit users.import
- Duration
- 10 min
This page has not been translated yet and is shown in French.
L'import CSV crée en une fois les comptes d'un client : utile pour reprendre une liste existante au démarrage d'un projet. Chaque ligne valide devient une fiche utilisateur dans l'environnement de l'appelant, avec un compte Keycloak dans le realm du réseau, sur l'instance de cet environnement.
Ce que l'import ne fait pas
- Il n'attribue aucun profil : les utilisateurs importés n'ont aucun droit dans votre application tant que vous ne leur attribuez pas un profil.
- Il crée les fiches dans un seul environnement : celui de la clé API utilisée, ou celui de la session de l'administrateur. Rien n'est copié dans les autres environnements, même pour une adresse qui y a déjà une fiche. Sans environnement déductible, l'import est refusé (
400), jamais rabattu sur la production. - Il n'envoie pas d'invitation : seul l'e-mail Keycloak de vérification de l'adresse et de définition du mot de passe part.
- Il ne rattache à aucune équipe.
Pour faire entrer des utilisateurs avec le bon profil dès le départ, utilisez les invitations.
Avant de commencer
- Vous appelez l'API avec une clé API ou le jeton d'un administrateur, de niveau Administrateur client au moins, avec le droit
users.import. Le téléchargement du modèle demandeusers.read. - Vous connaissez l'UUID du client (
id, renvoyé parGET /api/config/customers/{wid}). Un administrateur client ne peut importer que dans son propre client. - Vous utilisez une clé ou une session de l'environnement visé : pour importer en staging, une clé de staging.
- L'import consomme des crédits du client (opération
IMPORT_USERS), débités au lancement. Vérifiez le solde : voir Crédits.
Préparer le fichier
Télécharger le modèle
/api/import/users/templatecurl -o import-users-template.csv "https://api.wakastart.app/api/import/users/template" \
-H "x-api-key: sk_test_exemple"Résultat : un fichier import-users-template.csv avec l'en-tête et une ligne d'exemple.
Remplir une ligne par utilisateur
email,firstName,lastName,adminLevel
marie.dupont@cabinet-exemple.fr,Marie,Dupont,USER
paul.martin@cabinet-exemple.fr,Paul,Martin,CUSTOMER_ADMINemailest obligatoire ;firstNameetlastNamesont facultatifs ;adminLevelvautNONEs'il est vide, sinonCUSTOMER_ADMIN,USERouNONE; il ne peut pas dépasser votre propre niveau. Les niveaux d'administration au-delà du client (NETWORK_ADMIN,APP_ADMIN,PARTNER_ADMIN) sont refusés ligne par ligne : l'import ne crée que des utilisateurs du client.
Le séparateur est la virgule. Enregistrez le fichier en UTF-8 : 2 Mo et 500 lignes de données au plus.
Lancer l'import
/api/import/users?customerId={customerId}curl -X POST "https://api.wakastart.app/api/import/users?customerId=5d6e7f8a-9b0c-4d1e-8f2a-3b4c5d6e7f8a" \
-H "x-api-key: sk_test_exemple" \
-F "file=@utilisateurs.csv;type=text/csv"import { readFile } from "node:fs/promises";
const csv = await readFile("utilisateurs.csv");
const form = new FormData();
form.append("file", new Blob([csv], { type: "text/csv" }), "utilisateurs.csv");
const response = await fetch(
"https://api.wakastart.app/api/import/users?customerId=5d6e7f8a-9b0c-4d1e-8f2a-3b4c5d6e7f8a",
{ method: "POST", headers: { "x-api-key": process.env.WAKASTART_API_KEY! }, body: form },
);
const report = await response.json();Réponse attendue (201) :
{
"total": 2,
"successCount": 1,
"errorCount": 1,
"created": [
{ "line": 2, "email": "marie.dupont@cabinet-exemple.fr", "wid": "Us8hJ4" }
],
"errors": [
{ "line": 3, "email": "paul.martin@cabinet-exemple.fr", "error": "adminLevel CUSTOMER_ADMIN depasse votre niveau d'administration" }
]
}Le numéro de ligne compte l'en-tête comme ligne 1. Une ligne en erreur n'empêche pas l'import des autres. Une adresse qui a déjà une fiche chez ce client dans cet environnement est en erreur ; une fiche dans un autre environnement ne gêne pas.
Compléter les comptes importés
- Attribuez un profil à chaque utilisateur importé, dans le même environnement : voir Attribuer un profil.
- Si besoin, ajoutez-les à leurs équipes : voir Gérer les équipes.
Vérifier le résultat
GET /api/config/users?customerWid=Cu9pL2, appelé avec une clé du même environnement, liste les utilisateurs créés, avec les WID du rapport. Chacun reçoit l'e-mail Keycloak pour choisir son mot de passe.