Gérer les équipes
Créer des équipes dans un client, y ajouter des membres avec un niveau d'équipe et des droits d'équipe, changer ces niveaux et supprimer une équipe.
- Accès requis
- Niveau Administrateur client et droits teams.*
- Durée
- 10 min
Une équipe regroupe des utilisateurs d'un même client : un service, un site, un groupe projet. Chaque membre y a un niveau, et éventuellement des droits d'équipe que votre application interprète. Le modèle est expliqué dans Équipes et droits d'équipe.
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 :
teams.readpour lire,teams.create,teams.update,teams.deletepour gérer les équipes,teams.members.addpour gérer leurs membres. - Renommer une équipe exige en plus d'en être membre au niveau
ADMINouMANAGER; la supprimer, au niveauADMIN. Ces deux opérations se font donc avec le jeton d'un utilisateur membre.
Créer une équipe
/api/config/teamscurl -X POST "https://api.wakastart.app/api/config/teams" \
-H "x-api-key: sk_test_exemple" \
-H "Content-Type: application/json" \
-d '{ "name": "Secrétariat Lyon", "description": "Accueil et prise de rendez-vous" }'const response = await fetch("https://api.wakastart.app/api/config/teams", {
method: "POST",
headers: { "x-api-key": process.env.WAKASTART_API_KEY!, "Content-Type": "application/json" },
body: JSON.stringify({ name: "Secrétariat Lyon", description: "Accueil et prise de rendez-vous" }),
});
const team = await response.json();Réponse attendue (extrait) :
{ "id": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b", "wid": "Tm3qX7", "name": "Secrétariat Lyon" }L'équipe est créée dans votre client (customerId permet d'en viser un autre de votre périmètre). Le nom fait 100 caractères au plus. Le créateur n'est pas ajouté automatiquement comme membre.
Ajouter un membre
/api/config/teams/{wid}/members| Champ | Obligatoire | Description |
|---|---|---|
userId | oui | UUID de l'utilisateur (champ id de la liste des utilisateurs) |
teamLevel | non | ADMIN, MANAGER, MEMBER (par défaut), CONTRIBUTOR, VIEWER ou NONE |
appRights | non | Droits d'équipe : de 0 à 52 lettres A-Z et a-z, par exemple "RW" |
curl -X POST "https://api.wakastart.app/api/config/teams/Tm3qX7/members" \
-H "x-api-key: sk_test_exemple" \
-H "Content-Type: application/json" \
-d '{ "userId": "8b9c0d1e-2f3a-4b4c-9d5e-6f7a8b9c0d1e", "teamLevel": "MANAGER", "appRights": "RW" }'await fetch("https://api.wakastart.app/api/config/teams/Tm3qX7/members", {
method: "POST",
headers: { "x-api-key": process.env.WAKASTART_API_KEY!, "Content-Type": "application/json" },
body: JSON.stringify({
userId: "8b9c0d1e-2f3a-4b4c-9d5e-6f7a8b9c0d1e",
teamLevel: "MANAGER",
appRights: "RW",
}),
});Réponse attendue : le membre ajouté. Un utilisateur déjà membre renvoie 409.
Changer le niveau d'un membre
/api/config/teams/{teamWid}/members/{userWid}/rolecurl -X PATCH "https://api.wakastart.app/api/config/teams/Tm3qX7/members/Us2mK6/role" \
-H "x-api-key: sk_test_exemple" \
-H "Content-Type: application/json" \
-d '{ "teamLevel": "MEMBER", "appRights": "R" }'teamLevel est obligatoire, appRights facultatif. Le nouveau niveau est pris en compte à la prochaine émission de jeton enrichi de l'utilisateur.
Retirer un membre
/api/config/teams/{teamWid}/members/{userWid}curl -X DELETE "https://api.wakastart.app/api/config/teams/Tm3qX7/members/Us2mK6" \
-H "x-api-key: sk_test_exemple"Renommer ou supprimer une équipe
/api/config/teams/{wid}/api/config/teams/{wid}PUT accepte name et description. DELETE supprime l'équipe et toutes ses appartenances ; les utilisateurs, eux, sont conservés. Avec un niveau d'équipe insuffisant, l'API répond « Vous n'avez pas les droits pour modifier cette équipe » ou « Vous n'avez pas les droits pour supprimer cette équipe ».
Vérifier le résultat
GET /api/config/teams/Tm3qX7/members liste les membres avec leur niveau et leurs droits d'équipe. GET /api/config/teams affiche le nombre de membres de chaque équipe.