Skip to content

Référence des droits et profils

Champs et limites des niveaux d'administration, droits applicatifs, profils et droits de profil, réponse de /api/me et opérations de l'API publique.

ReferenceDeveloperAdministrator

This page has not been translated yet and is shown in French.

Cette page décrit les objets du modèle de droits. Le détail de chaque endpoint est dans la référence API des droits et profils.

Niveau d'administration

Valeur de l'APICode de la consoleLibellé de Mon profil
PARTNER_ADMINOwnerAdminAdministrateur Partenaire
APP_ADMINAppsAdminAdministrateur Applications
NETWORK_ADMINNetworkAdminAdministrateur Réseau
CUSTOMER_ADMINCustomerAdminAdministrateur Client
USERUserUtilisateur
NONENoneAucun

Claim du jeton enrichi : wadl.

Droit applicatif

ChampLibellé de la consoleTypeContraintes
idUUID
appIdUUIDobligatoire à la création
codeCodechaîne1 à 50 caractères, unique dans l'application, non modifiable
nameNomchaîne100 caractères, obligatoire
descriptionDescriptionchaîne
category(API)chaîne50 caractères
isSystembooléentrue : non modifiable, non supprimable

200 droits au plus par application. Un droit existe dans les trois environnements ; le champ availableEnvs a disparu et il est ignoré s'il est encore envoyé.

Profil

ChampLibellé de la consoleTypeContraintes
idUUID
widchaîne5 ou 6 caractères ; identifiant public, commun aux trois environnements
appIdUUIDobligatoire
networkId, customerIdUUIDrenseignés seulement pour un ancien profil de réseau ou de client, historique ; ne se créent plus
nameNomchaîne100 caractères, obligatoire, unique dans l'application
descriptionDescriptionchaîne
isActivebooléen
isSystembooléentrue : non modifiable, non supprimable

Droit d'un profil

ChampDescription
appRightIdUUID du droit
envTypeEnvironnement de la matrice où le profil porte le droit ; c'est toujours celui de l'appelant, jamais fourni

Un profil et un droit existent dans les trois environnements. Seule la matrice profils × droits est propre à chacun, sans copie ni promotion de l'un vers l'autre.

Masquage par réseau

Un profil d'application peut être masqué pour un réseau. Il n'est plus proposé aux clients de ce réseau ; les attributions existantes sont conservées.

Réponse de GET /api/me

ChampTypeDescription
wid, email, firstName, lastNamechaînesIdentité de la fiche de l'environnement de la session ; le wid est propre à cet environnement
isActivebooléenStatut
adminLevelchaîneNiveau d'administration (valeur de l'API)
hdsRolestableauRôles sur les données de santé
partner, network, customer{ wid, name }Organisation
teams[{ wid, name, teamLevel }]Équipes
profile{ wid, name, description, rights }Profil de l'environnement de la session
profile.rights[{ code, name, description, category }]Droits de ce profil dans la matrice de cet environnement
brandingobjetLogos, couleurs et thème résolus pour l'utilisateur
lastLoginAt, createdAtdates

Opérations de l'API publique

URL de base : https://api.wakastart.app/api. Toutes exigent le niveau Administrateur client au moins, sauf GET /me. Les profils se désignent par leur WID ({profile}), l'UUID restant accepté. Les opérations sur les droits et les utilisateurs d'un profil portent sur l'environnement de l'appelant ; env et envType y sont refusés en 400.

OpérationMéthode et cheminDroit
Lire son profil et ses droitsGET /meaucun ; jeton émis pour l'application
Lister les droitsGET /config/app-rights, GET /config/app-rights/by-app/{appWid}, GET /config/app-rights/{id}app-rights.read
Créer, modifier, supprimer un droitPOST /config/app-rights, PUT et DELETE /config/app-rights/{id}app-rights.create, app-rights.update, app-rights.delete
Lister, consulter les profilsGET /config/profiles, GET /config/profiles/{profile}profiles.read
Profils proposés à un clientGET /config/profiles/customer/{customerWid}/visibleprofiles.read
Profils d'un réseauGET /config/profiles/network/{networkWid}, GET /config/profiles/network/{networkWid}/availableprofiles.read
Créer, modifier, supprimer un profilPOST /config/profiles, PUT et DELETE /config/profiles/{profile}profiles.create, profiles.update, profiles.delete
Lire les droits d'un profilGET /config/profiles/{profile}/rightsaucun (administrateur client)
Ajouter, retirer un droitPOST et DELETE /config/profiles/{profile}/rights/{rightId}aucun (administrateur client)
Remplacer tous les droitsPUT /config/profiles/{profile}/rightsaucun (administrateur client)
Lister les utilisateurs d'un profilGET /config/profiles/{profile}/usersaucun (administrateur client)
Attribuer, retirer un profilPOST et DELETE /config/profiles/{profile}/users/{userWid}aucun (administrateur client)