Skip to content

Gérer un utilisateur

Modifier le nom ou le niveau d'un utilisateur, le désactiver, le réactiver ou le supprimer définitivement par l'API publique.

GuideDeveloperAdministrator
Required access
Niveau Administrateur client et droits users.update, users.disable, users.delete
Duration
5 min

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

Quand un collaborateur change de fonction ou quitte un client, mettez à jour sa fiche ou coupez son accès. Préférez la désactivation à la suppression : elle est réversible et conserve l'attribution de ses actions passées.

Chaque opération ne touche que la fiche de l'environnement de l'appelant et son compte Keycloak dans cet environnement. Si la personne a aussi une fiche dans un autre environnement, celle-ci ne bouge pas : traitez-la avec un jeton ou une clé de cet environnement.

Avant de commencer

  • Vous appelez l'API avec une clé API ou le jeton d'un administrateur, de niveau Administrateur client au moins.
  • Droits nécessaires : users.update pour modifier, users.disable pour désactiver ou réactiver, users.delete pour supprimer.
  • Vous connaissez le WID de la fiche dans l'environnement de l'appelant : voir Lister les utilisateurs. Le WID d'une fiche d'un autre environnement répond 404.

Modifier un utilisateur

PUT/api/config/users/{wid}

Champs modifiables : firstName, lastName, adminLevel (jamais au-dessus du vôtre) et isActive. L'adresse e-mail ne se modifie pas. Pour changer le profil, voir Attribuer un profil.

Bash
curl -X PUT "https://api.wakastart.app/api/config/users/Us2mK6" \
  -H "x-api-key: sk_test_exemple" \
  -H "Content-Type: application/json" \
  -d '{ "lastName": "Martin-Leroy", "adminLevel": "CUSTOMER_ADMIN" }'
TypeScript
await fetch("https://api.wakastart.app/api/config/users/Us2mK6", {
  method: "PUT",
  headers: { "x-api-key": process.env.WAKASTART_API_KEY!, "Content-Type": "application/json" },
  body: JSON.stringify({ lastName: "Martin-Leroy", adminLevel: "CUSTOMER_ADMIN" }),
});

Réponse attendue : la fiche à jour. Le nom est aussi mis à jour dans le compte Keycloak de cet environnement.

Désactiver ou réactiver

PATCH/api/config/users/{wid}/disable
PATCH/api/config/users/{wid}/enable
Bash
curl -X PATCH "https://api.wakastart.app/api/config/users/Us2mK6/disable" \
  -H "x-api-key: sk_test_exemple"
TypeScript
await fetch("https://api.wakastart.app/api/config/users/Us2mK6/disable", {
  method: "PATCH",
  headers: { "x-api-key": process.env.WAKASTART_API_KEY! },
});

Réponse attendue : la fiche avec "isActive": false.

Un utilisateur désactivé ne peut plus ouvrir de session dans cet environnement : son compte Keycloak de cet environnement est désactivé et Wakastart refuse d'enrichir ses jetons. Sa fiche, son profil et ses équipes sont conservés. Ses fiches des autres environnements restent actives. PATCH …/enable rétablit l'accès à l'identique.

Supprimer définitivement

DELETE/api/config/users/{wid}

Warning

La suppression est irréversible. Wakastart supprime la fiche de cet environnement, les clés API liées au compte, révoque ses sessions et supprime son compte Keycloak de cet environnement. Les fiches de la même personne dans les autres environnements sont conservées. Si la même identité Keycloak sert aussi dans un autre client du réseau, le compte est seulement retiré du client.

Bash
curl -X DELETE "https://api.wakastart.app/api/config/users/Us2mK6" \
  -H "x-api-key: sk_test_exemple"

Réponse attendue : un code 200 sans erreur. Si l'utilisateur est encore référencé ailleurs, par exemple comme auteur d'invitations, la suppression est refusée avec une erreur 409 : désactivez-le à la place.

Vérifier le résultat

  • Après une désactivation, GET /api/config/users/Us2mK6 renvoie "isActive": false et l'utilisateur ne peut plus se connecter à votre application.
  • Après une suppression, le même appel renvoie 404. Une fiche de la même adresse dans un autre environnement reste visible depuis cet environnement.

Voir aussi