💙GET : Auth User

Nom de l'API : /auth/user (GET)

Description : Cette API GET permet de récupérer les informations de l'utilisateur authentifié et de son espace de travail associé. Elle nécessite une authentification et utilise le token d'authentification pour identifier l'utilisateur.

Endpoint : /auth/user

Méthode : GET

Authentification : Requise

Paramètres d'entrée : Aucun paramètre d'entrée spécifique n'est requis. L'API utilise le token d'authentification pour identifier l'utilisateur.

Fonctionnement détaillé :

  1. Get Record From users

    • Récupère les informations de l'utilisateur authentifié

    • Paramètres de recherche : • field_name : "id" • field_value : auth:id (ID de l'utilisateur authentifié)

    • Retourne le résultat sous le nom "current_user"

  2. Create Variable search_workspace

    • Crée une variable pour stocker les informations de recherche de l'espace de travail

    • Structure : • Array " [] " • Ajoute un objet avec :

      • users_id : current_user.id

  3. Query All Records From workspace

    • Récupère les informations de l'espace de travail de l'utilisateur

    • Filtre : db:workspace.users contains var:search_workspace

    • Retourne le résultat sous le nom "current_workspace"

Réponse : L'API renvoie un objet JSON contenant :

  • user : Les informations de l'utilisateur (var: current_user)

  • workspace : Les informations de l'espace de travail de l'utilisateur (var: current_workspace)

Notes supplémentaires :

  • Cette API nécessite une authentification, ce qui signifie qu'elle doit être appelée avec un token d'authentification valide.

  • Elle récupère à la fois les informations de l'utilisateur et celles de son espace de travail associé.

  • La structure de la requête permet de gérer les cas où un utilisateur pourrait être associé à plusieurs espaces de travail, bien que dans cette implémentation, il semble qu'un utilisateur n'ait qu'un seul espace de travail.

  • L'API ne modifie aucune donnée, elle se contente de lire et de renvoyer les informations existantes.

  • Cette API est utile pour récupérer les détails de l'utilisateur après une connexion réussie ou pour rafraîchir les informations de l'utilisateur dans l'application cliente.

Dernière mise à jour