Skip to content

Créer un utilisateur

Créer directement la fiche d'un utilisateur par l'API publique, dans l'environnement de l'appelant et avec son profil, sans passer par une invitation.

GuideDeveloperAdministrator
Required access
Niveau Administrateur client et droit users.create
Duration
10 min

This page has not been translated yet and is shown in French.

Créez directement un utilisateur quand vous connaissez déjà son identité, par exemple lors d'une reprise de données ou d'une synchronisation avec votre annuaire. Keycloak lui envoie ensuite un e-mail pour vérifier son adresse et choisir son mot de passe. Dans les autres cas, préférez l'invitation.

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.create.
  • Vous connaissez le WID du client et celui du profil à attribuer.
  • Un administrateur client crée toujours l'utilisateur dans son propre client, quel que soit le client indiqué.
  • Vous appelez avec un jeton ou une clé de l'environnement visé : la fiche est créée dans l'environnement de l'appelant, et seulement dans celui-là. Voir Comptes et environnements.

Créer l'utilisateur

POST/api/config/users
Bash
curl -X POST "https://api.wakastart.app/api/config/users" \
  -H "x-api-key: sk_test_exemple" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "paul.martin@cabinet-exemple.fr",
    "firstName": "Paul",
    "lastName": "Martin",
    "customerWid": "Cu9pL2",
    "profileWid": "Pr5sT1",
    "adminLevel": "USER"
  }'
TypeScript
const response = await fetch("https://api.wakastart.app/api/config/users", {
  method: "POST",
  headers: {
    "x-api-key": process.env.WAKASTART_API_KEY!,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "paul.martin@cabinet-exemple.fr",
    firstName: "Paul",
    lastName: "Martin",
    customerWid: "Cu9pL2",
    profileWid: "Pr5sT1",
    adminLevel: "USER",
  }),
});
const user = await response.json();
if (user.reconciledWithoutInvite) {
  console.warn("Compte Keycloak existant réutilisé : aucun e-mail envoyé.");
}

Réponse attendue (201, extrait) :

JSON
{
  "id": "8b9c0d1e-2f3a-4b4c-9d5e-6f7a8b9c0d1e",
  "wid": "Us2mK6",
  "email": "paul.martin@cabinet-exemple.fr",
  "firstName": "Paul",
  "lastName": "Martin",
  "adminLevel": "USER",
  "isActive": true,
  "envType": "prod"
}

Wakastart crée la fiche dans l'environnement de la clé (ici prod), crée le compte Keycloak dans le realm du réseau sur l'instance de cet environnement, l'ajoute au groupe et à l'organisation du client, ouvre l'accès à l'application et attribue le profil à la fiche. Keycloak envoie l'e-mail de vérification et de définition du mot de passe, valable 24 heures.

Champs de la requête

ChampObligatoireDescription
emailoui255 caractères au plus ; enregistrée en minuscules
customerWidnonClient de l'utilisateur. customerId accepte l'UUID. Par défaut, le client de l'appelant.
firstName, lastNamenon100 caractères chacun
profileWidnonProfil attribué à la fiche, avec les droits de l'environnement de l'appelant. profileId accepte l'UUID.
adminLevelnonCUSTOMER_ADMIN, USER ou NONE (par défaut). Jamais supérieur au niveau de l'appelant.
temporaryPasswordnonMot de passe provisoire (8 caractères au moins), à changer à la première connexion
requireEmailVerificationnontrue par défaut : l'utilisateur doit vérifier son adresse
isActivenontrue par défaut

Important

N'envoyez ni envs, ni envType, ni env : l'environnement est déduit de l'appelant, et ces champs sont refusés en 400 (Environment is deduced from the caller and cannot be provided). Pour créer la même personne dans un autre environnement, refaites l'appel avec un jeton ou une clé de cet environnement : il n'existe ni copie ni promotion de fiche.

Note

Si un compte Keycloak vérifié et actif existe déjà pour cette adresse dans le realm de cet environnement, Wakastart le réutilise et n'envoie aucun e-mail ; la réponse contient "reconciledWithoutInvite": true. Prévenez alors l'utilisateur qu'il peut se connecter avec son mot de passe habituel.

Vérifier le résultat

GET /api/config/users/Us2mK6, appelé avec une clé du même environnement, renvoie l'utilisateur, actif, rattaché au client, avec "envType": "prod". L'utilisateur reçoit l'e-mail de Keycloak, choisit son mot de passe et se connecte à votre application.

Dépannage

  • Erreur 409 : un utilisateur avec cette adresse existe déjà dans ce client, dans cet environnement. Une fiche de la même adresse dans un autre environnement ne bloque pas la création.
  • Erreur 400 Environment is deduced from the caller and cannot be provided : retirez envs, envType ou env du corps.
  • Erreur 403 : le niveau demandé dépasse le vôtre, ou le droit users.create vous manque. Voir Résoudre les problèmes d'utilisateurs.

Voir aussi