Aller au contenu principal

Modifier un utilisateur

Ce guide explique comment mettre à jour un utilisateur existant sur la plateforme Stonal à l'aide de l'API. Comme pour la création d'un utilisateur, la mise à jour d'un utilisateur nécessite de rassembler les informations actuelles avant d'effectuer les modifications.

Prérequis
  • Des identifiants d'accès à l'API
  • Un jeton d'accès valide (voir : Obtenir un jeton)
  • Un code d'organisation
Mise à jour par e-mail

Si vous souhaitez mettre à jour un utilisateur existant par e-mail, vous pouvez suivre le processus de création précédent, tel que décrit : Ici

Le point de terminaison de création mettra à jour l'utilisateur s'il existe déjà.

Étape 1 : Récupérer les informations de l'utilisateur à modifier​

Vérifiez les sociétés disponibles pouvant être attribuées à l'utilisateur :

Voir : Spécification de l'API

GET /v1/organizations/{organizationCode}/users/companies

Paramètres de requête :

  • page (optionnel) : Numéro de page (par défaut : 0)
  • size (optionnel) : Éléments par page (par défaut : 100)

Les sociétés obtenues peuvent être utilisées pour mettre à jour un utilisateur avec le champ company. L'utilisateur obtient ainsi le droit d'accéder aux objets de la société correspondante.

Étape 2 : Mettre à jour l'utilisateur​

Mettez à jour l'utilisateur avec les informations modifiées :

Voir : Spécification de l'API

PUT /v1/organizations/{organizationCode}/users/{id}

Corps de la requête :

{
  "firstName": "updatedFirstName",
  "lastName": "updatedLastName",
  "company": "updatedCompanyName",
  "groupUids": ["0192d7b7-2994-7ad5-9952-26862f33c21a"],
  "authorization": {
    "modelId": "2b2e8a4b-bfbd-4c56-b8d6-c8cb1d8c58ba",
    "profile": "Developer",
    "asset": {
      "all": false
    }
  },
  "permissionUids": [
    "0192d7b7-2994-7ad5-9952-26862f33c21a",
    "0192d7b7-7073-7e58-896c-07113f22363a"
  ]
}

Champs requis :

  • firstName : Prénom de l'utilisateur
  • lastName : Nom de l'utilisateur
  • company : Nom de la société (doit faire partie des sociétés disponibles)
  • groupUids : Tableau des UID de groupes
  • authorization : Configuration de l'autorisation
    • modelId : Identifiant du modèle d'autorisation
    • profile : Profil de l'utilisateur
    • asset : Configuration de l'accès aux objets
  • permissionUids : Tableau des UID d'autorisations

Remarque : Contrairement à la création, la requête de mise à jour n'inclut pas l'adresse e-mail, car elle ne peut pas être modifiée.

Réponses possibles :

  • 204 : Utilisateur mis à jour avec succès
  • 404 : Utilisateur introuvable

Principales différences avec la création​

Lors de la mise à jour d'un utilisateur, notez ces différences importantes :

  1. L'adresse e-mail ne peut pas être modifiée
  2. Utilisez la méthode PUT au lieu de POST
  3. Nécessite l'identifiant de l'utilisateur dans le chemin
  4. Renvoie 204 (pas de contenu) en cas de succès au lieu de 201

Considérations importantes​

  1. Mises à jour partielles : L'API ne prend pas en charge les mises à jour partielles. Vous devez fournir tous les champs requis dans la requête de mise à jour, même si vous ne modifiez qu'une seule valeur.

  2. Accès aux objets :

    • Lors de la modification de l'accès aux objets, fournissez l'ensemble complet et nouveau des codes d'objets
    • Définir "all": true remplace toute autorisation spécifique pour le type d'objet

  3. Autorisations :

    • Fournissez l'ensemble complet et nouveau des UID d'autorisations
    • Toutes les autorisations existantes seront remplacées
    • Tous les UID d'autorisations doivent être valides

  4. Modèle d'autorisation :

    • Modifier le modèle d'autorisation peut affecter l'accès de l'utilisateur à diverses fonctionnalités
    • Assurez-vous que le nouveau modèle fournit les niveaux d'accès appropriés

Gestion des erreurs​

Scénarios d'erreur courants :

  • Utilisateur introuvable (404)
  • Identifiant de modèle d'autorisation invalide
  • Nom de société invalide
  • UID de groupes invalides
  • UID d'autorisations invalides
  • Champs requis manquants
  • Format invalide des codes d'objets

Bonnes pratiques​

  1. Récupérez toujours les données actuelles de l'utilisateur avant la mise à jour
  2. Validez toutes les nouvelles valeurs par rapport aux points de terminaison de récupération
  3. Gardez une trace des modifications sensibles (autorisation, autorisations)
  4. Implémentez une gestion appropriée des erreurs pour les réponses 404