Skip to content

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.

ReferenceDeveloperAdministrator

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

ChampTypeContraintesDescription
idUUIDpropre à la ficheIdentifiant interne, utilisé pour l'ajout à une équipe
widchaîne6 caractères, propre à la ficheIdentifiant court, utilisé dans les URL
emailchaîne255 caractères, unique par client et par environnement, en minusculesAdresse de connexion, non modifiable
envTypeénumérationdev, staging, prodEnvironnement de la fiche : celui de l'appelant qui l'a créée ou de l'invitation acceptée. Non modifiable
keycloakIdchaîneCompte Keycloak de la fiche, sur l'instance de son environnement
firstName, lastNamechaîne100 caractères chacunPrénom, nom
adminLevelénumérationPARTNER_ADMIN, APP_ADMIN, NETWORK_ADMIN, CUSTOMER_ADMIN, USER, NONENiveau d'administration ; NONE par défaut
isActivebooléentrue par défautActif ou désactivé
customerIdUUIDobligatoireClient de l'utilisateur
lastLoginAtdateDerniè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

ChampTypeContraintesDescription
idUUIDIdentifiant
invitedEmailchaîneadresse validePersonne invitée
invitedFirstName, invitedLastNamechaîne100 caractères chacunRepris dans l'e-mail
customerIdUUID ou WIDobligatoireClient à rejoindre. customerWid est déprécié
profileWidWIDobligatoireProfil attribué à l'acceptation ; profileId (UUID) reste accepté
envTypeénumérationdev, staging, prod ; lecture seuleEnvironnement de l'invitation : celui de l'inviteur. Fourni dans la requête, il est refusé (400)
teamAssignmentstableau[{ teamId | teamWid, teamLevel }]Équipes rejointes à l'acceptation
languagechaînefr (défaut), en, es, de, nl, it, ptLangue de l'e-mail
statusénumérationvoir le tableau des statutsStatut
expiresAtdateenvoi + durée de validitéÉchéance

Le jeton d'une invitation fait 64 caractères hexadécimaux en minuscules.

Statuts d'une invitation

StatutSignificationRelanceAnnulation
PENDINGEn attenteouioui
ACCEPTEDAcceptée, compte créénon (400)non (400)
EXPIREDÉchéance passéeouioui
CANCELLEDAnnuléeouisans effet

Réglages d'invitation de l'application

ChampLibellé de la consoleValeursPar défaut
invitationsEnabledActiver les invitationsbooléentrue
invitationVerifyEmailVérification email obligatoirebooléentrue
invitationNotifyInviterNotification à l'inviteurbooléenfalse
acceptInvitationUrlURL d'acceptation des invitationsURL http(s), 500 caractères, marqueur {token}vide
invitationExpiryDays(API)1 à 365 jours10
invitationPerUserLimit(API)1 à 10 000 par auteur sur 30 jours, ou nullnull

Équipe

ChampTypeContraintesDescription
widchaîne6 caractèresIdentifiant court
customerIdUUIDClient de l'équipe
namechaîne100 caractères, obligatoireNom
descriptionchaîneDescription

Membre d'une équipe

ChampValeursDescription
teamLevelADMIN, MANAGER, MEMBER (défaut), CONTRIBUTOR, VIEWER, NONENiveau dans l'équipe
appRights0 à 52 lettres A-Z, a-zDroits d'équipe, interprétés par votre application

Import CSV

PropriétéValeur
Colonnesemail (obligatoire), firstName, lastName, adminLevel
Séparateurvirgule
Taille2 Mo, 500 lignes de données
Niveau par défautNONE ; seuls CUSTOMER_ADMIN, USER et NONE sont acceptés
EnvironnementCelui de l'appelant ; import refusé s'il ne peut pas être déduit
Coûtopé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érationMéthode et cheminAccès
Lister les utilisateursGET /config/usersAdministrateur client + users.read
Rechercher par e-mailGET /config/users/search?email=Administrateur client + users.read
Consulter un utilisateurGET /config/users/{wid}Administrateur client + users.read
StatistiquesGET /config/users/statsAdministrateur client + users.stats
Créer un utilisateurPOST /config/usersAdministrateur client + users.create
Modifier un utilisateurPUT /config/users/{wid}Administrateur client + users.update
Désactiver, réactiverPATCH /config/users/{wid}/disable, /enableAdministrateur client + users.disable
Supprimer un utilisateurDELETE /config/users/{wid}Administrateur client + users.delete
Modèle CSVGET /import/users/templateAdministrateur client + users.read
Importer un CSVPOST /import/users?customerId={uuid}Administrateur client + users.import + crédits
InviterPOST /invitationsAdministrateur client + invitations.create
Lister les invitationsGET /invitations/sent, GET /invitations/by-customer/{customerId}invitations.read
Consulter une invitationGET /invitations/{id}invitations.read
RelancerPOST /invitations/{id}/resendinvitations.create
AnnulerDELETE /invitations/{id}invitations.revoke
Vérifier un lienGET /invitations/verify/{token}public
AccepterPOST /invitations/accept/{token}public
ÉquipesGET, POST /config/teams ; GET, PUT, DELETE /config/teams/{wid}Administrateur client + teams.read, teams.create, teams.update, teams.delete
Membres d'une équipeGET, 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.