Aller au contenu

Attribuer un profil

Donner un profil à un utilisateur dans son environnement, au moment de l'invitation, de la création de sa fiche, ou après coup.

GuideDéveloppeurAdministrateur
Accès requis
Niveau Administrateur client ; droit invitations.create ou users.create selon le moment
Durée
5 min
Voir en Markdown

Un utilisateur tient ses droits du profil de sa fiche. Comme une fiche appartient à un seul environnement, l'attribution ne vaut que pour cet environnement : si la même personne a une fiche ailleurs, attribuez-lui son profil depuis cet autre environnement. Le plus sûr est de fixer le profil dès l'arrivée de l'utilisateur ; vous pouvez aussi l'attribuer ensuite.

Avant de commencer

  • Le profil existe et il est proposé au client de l'utilisateur. Listez les profils disponibles pour un client :
Bash
curl "https://api.wakastart.app/api/config/profiles/customer/Cu9pL2/visible" \
  -H "x-api-key: sk_test_exemple"

La réponse liste les profils de l'application que le réseau du client ne masque pas, avec leur wid et leur id. Désignez un profil par son wid : c'est son identifiant public, commun aux trois environnements.

  • Vous appelez l'API avec une clé API ou le jeton d'un administrateur, de niveau Administrateur client au moins, de l'environnement de la fiche : toutes ces opérations agissent dans l'environnement de l'appelant.

À l'invitation

Indiquez profileWid dans l'invitation (droit invitations.create). La personne reçoit ce profil en acceptant, dans l'environnement de l'invitation, c'est-à-dire celui de l'inviteur.

JSON
{
  "invitedEmail": "marie.dupont@cabinet-exemple.fr",
  "customerId": "Cu9pL2",
  "profileWid": "Pr5sT1"
}

Voir Inviter un utilisateur.

À la création de la fiche

Indiquez profileWid à la création (droit users.create). Le profil est attribué à la fiche créée, dans l'environnement de l'appelant.

JSON
{
  "email": "paul.martin@cabinet-exemple.fr",
  "customerWid": "Cu9pL2",
  "profileWid": "Pr5sT1"
}

Voir Créer un utilisateur.

Après coup

Pour un utilisateur existant, par exemple importé sans profil, attribuez le profil à sa fiche. Cette opération est réservée aux administrateurs client et ne demande aucun autre droit.

POST/api/config/profiles/{profile}/users/{userWid}

{profile} est le WID du profil ; {userWid} est le WID de la fiche dans l'environnement de l'appelant.

Bash
curl -X POST "https://api.wakastart.app/api/config/profiles/Pr5sT1/users/Us8hJ4" \
  -H "x-api-key: sk_test_exemple"
TypeScript
const response = await fetch("https://api.wakastart.app/api/config/profiles/Pr5sT1/users/Us8hJ4", {
  method: "POST",
  headers: { "x-api-key": process.env.WAKASTART_API_KEY! },
});
if (response.status === 409) console.info("Profil déjà attribué à cette fiche.");

Réponse attendue : 201 et la fiche de l'utilisateur. Un profil déjà attribué répond 409 ; le WID d'une fiche d'un autre environnement répond 404.

Pour retirer un profil : DELETE /api/config/profiles/{profile}/users/{userWid}.

Note

PUT /api/config/users/{wid} accepte aussi profileId (UUID du profil, droit users.update) : le profil est ajouté à la fiche, dans son environnement, sans retirer ceux déjà attribués. Préférez la route d'attribution décrite plus haut dans cette page, qui désigne le profil par son WID.

Vérifier le résultat

Faites appeler GET /api/me par l'utilisateur, dans une session de l'environnement de la fiche : profile.name est le profil attribué et profile.rights liste ses droits dans la matrice de cet environnement. Voir Vérifier un droit dans votre application.

Voir aussi