Référence des utilisateurs, invitations et équipes
Champs, statuts et limites des utilisateurs, des invitations et des équipes, et opérations de l'API publique avec leurs droits.
This page has not been translated yet and is shown in French.
Cette page décrit les objets manipulés dans cette section. Les paramètres et codes de réponse de chaque endpoint sont détaillés dans la référence API des utilisateurs, des invitations et des équipes.
Utilisateur
| Champ | Type | Contraintes | Description |
|---|---|---|---|
id | UUID | propre à la fiche | Identifiant interne, utilisé pour l'ajout à une équipe |
wid | chaîne | 6 caractères, propre à la fiche | Identifiant court, utilisé dans les URL |
email | chaîne | 255 caractères, unique par client et par environnement, en minuscules | Adresse de connexion, non modifiable |
envType | énumération | dev, staging, prod | Environnement de la fiche : celui de l'appelant qui l'a créée ou de l'invitation acceptée. Non modifiable |
keycloakId | chaîne | Compte Keycloak de la fiche, sur l'instance de son environnement | |
firstName, lastName | chaîne | 100 caractères chacun | Prénom, nom |
adminLevel | énumération | PARTNER_ADMIN, APP_ADMIN, NETWORK_ADMIN, CUSTOMER_ADMIN, USER, NONE | Niveau d'administration ; NONE par défaut |
isActive | booléen | true par défaut | Actif ou désactivé |
customerId | UUID | obligatoire | Client de l'utilisateur |
lastLoginAt | date | Dernière connexion |
Une même adresse peut avoir une fiche par environnement chez un client : trois fiches indépendantes, chacune avec son id et son wid. Mot de passe : 8 caractères au moins. Lien de l'e-mail Keycloak envoyé à la création : 24 heures.
Invitation
| Champ | Type | Contraintes | Description |
|---|---|---|---|
id | UUID | Identifiant | |
invitedEmail | chaîne | adresse valide | Personne invitée |
invitedFirstName, invitedLastName | chaîne | 100 caractères chacun | Repris dans l'e-mail |
customerId | UUID ou WID | obligatoire | Client à rejoindre. customerWid est déprécié |
profileWid | WID | obligatoire | Profil attribué à l'acceptation ; profileId (UUID) reste accepté |
envType | énumération | dev, staging, prod ; lecture seule | Environnement de l'invitation : celui de l'inviteur. Fourni dans la requête, il est refusé (400) |
teamAssignments | tableau | [{ teamId | teamWid, teamLevel }] | Équipes rejointes à l'acceptation |
language | chaîne | fr (défaut), en, es, de, nl, it, pt | Langue de l'e-mail |
status | énumération | voir le tableau des statuts | Statut |
expiresAt | date | envoi + durée de validité | Échéance |
Le jeton d'une invitation fait 64 caractères hexadécimaux en minuscules.
Statuts d'une invitation
| Statut | Signification | Relance | Annulation |
|---|---|---|---|
PENDING | En attente | oui | oui |
ACCEPTED | Acceptée, compte créé | non (400) | non (400) |
EXPIRED | Échéance passée | oui | oui |
CANCELLED | Annulée | oui | sans effet |
Réglages d'invitation de l'application
| Champ | Libellé de la console | Valeurs | Par défaut |
|---|---|---|---|
invitationsEnabled | Activer les invitations | booléen | true |
invitationVerifyEmail | Vérification email obligatoire | booléen | true |
invitationNotifyInviter | Notification à l'inviteur | booléen | false |
acceptInvitationUrl | URL d'acceptation des invitations | URL http(s), 500 caractères, marqueur {token} | vide |
invitationExpiryDays | (API) | 1 à 365 jours | 10 |
invitationPerUserLimit | (API) | 1 à 10 000 par auteur sur 30 jours, ou null | null |
Équipe
| Champ | Type | Contraintes | Description |
|---|---|---|---|
wid | chaîne | 6 caractères | Identifiant court |
customerId | UUID | Client de l'équipe | |
name | chaîne | 100 caractères, obligatoire | Nom |
description | chaîne | Description |
Membre d'une équipe
| Champ | Valeurs | Description |
|---|---|---|
teamLevel | ADMIN, MANAGER, MEMBER (défaut), CONTRIBUTOR, VIEWER, NONE | Niveau dans l'équipe |
appRights | 0 à 52 lettres A-Z, a-z | Droits d'équipe, interprétés par votre application |
Import CSV
| Propriété | Valeur |
|---|---|
| Colonnes | email (obligatoire), firstName, lastName, adminLevel |
| Séparateur | virgule |
| Taille | 2 Mo, 500 lignes de données |
| Niveau par défaut | NONE ; seuls CUSTOMER_ADMIN, USER et NONE sont acceptés |
| Environnement | Celui de l'appelant ; import refusé s'il ne peut pas être déduit |
| Coût | opération de crédits IMPORT_USERS, débitée au lancement |
Opérations de l'API publique
URL de base : https://api.wakastart.app/api.
| Opération | Méthode et chemin | Accès |
|---|---|---|
| Lister les utilisateurs | GET /config/users | Administrateur client + users.read |
| Rechercher par e-mail | GET /config/users/search?email= | Administrateur client + users.read |
| Consulter un utilisateur | GET /config/users/{wid} | Administrateur client + users.read |
| Statistiques | GET /config/users/stats | Administrateur client + users.stats |
| Créer un utilisateur | POST /config/users | Administrateur client + users.create |
| Modifier un utilisateur | PUT /config/users/{wid} | Administrateur client + users.update |
| Désactiver, réactiver | PATCH /config/users/{wid}/disable, /enable | Administrateur client + users.disable |
| Supprimer un utilisateur | DELETE /config/users/{wid} | Administrateur client + users.delete |
| Modèle CSV | GET /import/users/template | Administrateur client + users.read |
| Importer un CSV | POST /import/users?customerId={uuid} | Administrateur client + users.import + crédits |
| Inviter | POST /invitations | Administrateur client + invitations.create |
| Lister les invitations | GET /invitations/sent, GET /invitations/by-customer/{customerId} | invitations.read |
| Consulter une invitation | GET /invitations/{id} | invitations.read |
| Relancer | POST /invitations/{id}/resend | invitations.create |
| Annuler | DELETE /invitations/{id} | invitations.revoke |
| Vérifier un lien | GET /invitations/verify/{token} | public |
| Accepter | POST /invitations/accept/{token} | public |
| Équipes | GET, POST /config/teams ; GET, PUT, DELETE /config/teams/{wid} | Administrateur client + teams.read, teams.create, teams.update, teams.delete |
| Membres d'une équipe | GET, POST /config/teams/{wid}/members ; PATCH /config/teams/{teamWid}/members/{userWid}/role ; DELETE /config/teams/{teamWid}/members/{userWid} | Administrateur client + teams.read ou teams.members.add |
Toutes ces opérations portent sur l'environnement de l'appelant (session ou clé API) ; les paramètres env, envType et envs sont refusés en 400.
Limites de débit : 10 requêtes par seconde, 100 par minute et 1 000 par heure par adresse IP ; 60 par seconde, 600 par minute et 5 000 par heure pour la vérification et l'acceptation d'une invitation.