Aller au contenu

Créer un profil

Créer un profil d'application, commun aux trois environnements, puis cocher ses droits dans la matrice de chaque environnement.

GuideDéveloppeurPartenaireAdministrateur
Accès requis
Niveau Administrateur client et droit profiles.create
Durée
10 min
Voir en Markdown

Un profil regroupe les droits d'un type d'utilisateur : « Secrétariat », « Gérant », « Lecture seule ». Créez-le une fois pour l'application : il existe aussitôt dans les trois environnements. Réglez ensuite ses droits dans la matrice de chaque environnement.

Avant de commencer

  • Les droits existent dans le catalogue de l'application : voir Définir les droits de votre application.
  • Vous avez le niveau Administrateur client au moins et le droit profiles.create. Le réglage des droits d'un profil est réservé aux administrateurs client, sans autre droit.
  • Choisissez un nom qui n'existe pas encore dans l'application : deux profils de la même application ne peuvent pas porter le même nom.

Créer le profil

Un profil d'application est proposé à tous les clients de l'application, sauf dans les réseaux qui le masquent.

Ouvrir l'onglet Profils

Dans le menu latéral, sous le nom de votre application, cliquez sur Paramétrage, puis ouvrez l'onglet Profils.

Résultat : la carte Profils de l'application liste les profils, ou « Aucun profil défini ».

Créer le profil

Cliquez sur Nouveau profil, puis renseignez :

  • Nom : 100 caractères au plus, unique dans l'application, par exemple « Secrétariat » ;
  • Description : facultative.

Enregistrer

Cliquez sur Créer.

Résultat : le message « Profil créé » s'affiche. Le profil existe dans les trois environnements, sans aucun droit.

POST/api/config/profiles
Bash
curl -X POST "https://api.wakastart.app/api/config/profiles" \
  -H "Authorization: Bearer $WAKASTART_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "appId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
    "name": "Secrétariat",
    "description": "Agenda et accueil"
  }'
TypeScript
const response = await fetch("https://api.wakastart.app/api/config/profiles", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.WAKASTART_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    appId: "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
    name: "Secrétariat",
    description: "Agenda et accueil",
  }),
});
const profile = await response.json();

Réponse attendue (201, extrait) :

JSON
{
  "id": "6c7d8e9f-0a1b-4c2d-8e3f-4a5b6c7d8e9f",
  "wid": "Pr5sT1",
  "name": "Secrétariat",
  "isSystem": false
}

Notez le wid : c'est l'identifiant public du profil, à utiliser dans toutes les routes de profils et dans les invitations. Un nom déjà pris dans l'application répond 409. Le champ availableEnvs n'existe plus : s'il est encore envoyé, il est ignoré.

Régler les droits du profil

Les droits d'un profil se règlent environnement par environnement. Modifier la matrice d'un environnement ne touche jamais les deux autres, et rien ne se copie d'un environnement vers un autre.

Ouvrir la matrice

Dans Paramétrage, ouvrez l'onglet Matrice.

Résultat : tant qu'aucun environnement n'est choisi, l'onglet affiche « Choisissez un environnement ».

Choisir l'environnement

Dans le sélecteur Environnement, cliquez sur Production, Staging ou Dev.

Résultat : la carte Matrice droits / profils affiche les droits de chaque profil dans cet environnement uniquement.

Cocher les droits

Cochez une case pour accorder un droit à un profil, décochez-la pour le retirer.

Résultat : le changement s'applique immédiatement dans cet environnement. Recommencez pour chaque environnement où le profil doit porter des droits.

Les routes de droits agissent toujours dans l'environnement de l'appelant : celui de votre session, ou celui de votre clé API. Pour régler la matrice de staging, appelez-les avec un jeton ou une clé de staging.

POST/api/config/profiles/{profile}/rights/{rightId}

{profile} est le WID du profil (l'UUID reste accepté) ; {rightId} est l'UUID du droit. Aucun corps n'est attendu.

Bash
curl -X POST "https://api.wakastart.app/api/config/profiles/Pr5sT1/rights/2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e" \
  -H "x-api-key: sk_test_exemple"
TypeScript
const profile = "Pr5sT1";
const rightIds = ["2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e"];

for (const rightId of rightIds) {
  const response = await fetch(
    `https://api.wakastart.app/api/config/profiles/${profile}/rights/${rightId}`,
    { method: "POST", headers: { "x-api-key": process.env.WAKASTART_API_KEY! } },
  );
  if (!response.ok) throw new Error(`Droit ${rightId} : HTTP ${response.status}`);
}

Réponse attendue : 201. Un droit déjà présent dans cet environnement répond 409.

Pour remplacer d'un coup tous les droits du profil dans l'environnement de l'appelant, utilisez PUT /api/config/profiles/{profile}/rights avec la liste complète :

JSON
{
  "entries": [
    { "appRightId": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e" },
    { "appRightId": "3c4d5e6f-7a8b-4c9d-8e0f-2a3b4c5d6e7f" }
  ]
}

Une liste vide retire tous les droits du profil dans cet environnement ; les deux autres environnements ne sont pas touchés.

Pour retirer un droit : DELETE /api/config/profiles/{profile}/rights/{rightId}, sans corps.

Note

N'envoyez ni env ni envType, dans l'adresse comme dans le corps : ils sont refusés en 400 (Environment is deduced from the caller and cannot be provided).

Vérifier le résultat

Bash
curl "https://api.wakastart.app/api/config/profiles/Pr5sT1/rights" \
  -H "x-api-key: sk_test_exemple"

La réponse liste les droits du profil dans l'environnement de la clé. Le profil apparaît aussi dans GET /api/config/profiles/customer/{customerWid}/visible pour les clients dont le réseau ne le masque pas.

Voir aussi