GOFAST-13037 - add users directory doc

docs-gofast-development/api-rest.rst

@@ -1791,3 +1791,66 @@ Cette méthode permet d'ajouter un membre à la liste d'utilisateurs.
 +=======================+======================================================================+
 |status                 |Statut de l'ajout                                                     |
 +-----------------------+----------------------------------------------------------------------+
+
+Ressource : directory
+**********************
+
+Cette ressource permet de consulter les annuaires.
+
+Action : userlist
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Cette action permet de consulter l'annuaire des utilisateurs.
+
+GET
+__________
+
+Cette méthode permet de récupérer l'annuaire des utilisateurs.
+
+*GET: /api/directory/users*
+
++-------------------+--------------------------+
+|  Header           |   Valeur                 |
++===================+==========================+
+|Content-Type       | application/json         |
++-------------------+--------------------------+
+
++-------------------+----------------------------------------------+
+|  Clé              |   Valeur                                     |
++===================+==============================================+
+|perpage            |Nombre d'éléments par page                    |
++-------------------+----------------------------------------------+
+|page               |Numéro de pages dont renvoyer les résultats   |
++-------------------+----------------------------------------------+
+
+*Retour:*
+
++-------------------+----------------------------------------+
+|   Header          |   Valeur                               |
++===================+========================================+
+|Content-Type       | application/json                       |
++-------------------+----------------------------------------+
+
++-----------------------+----------------------------------------------------------------------+
+|   Clé                 |   Valeur                                                             |
++=======================+======================================================================+
+|users                  |Tableau des résultats                                                 |
++-----------------------+----------------------------------------------------------------------+
+
+Les résultats unitaires sont formatés comme suit :
+
++-----------------------+----------------------------------------------------------------------+
+|   Clé                 |   Valeur                                                             |
++=======================+======================================================================+
+|uid                    |ID de l'utilisateur                                                   |
++-----------------------+----------------------------------------------------------------------+
+|last_login             |Horodatage de la dernière date de connexion                           |
++-----------------------+----------------------------------------------------------------------+
+|username               |Identifiant de connexion                                              |
++-----------------------+----------------------------------------------------------------------+
+|mail                   |Adresse mail                                                          |
++-----------------------+----------------------------------------------------------------------+
+|firstname              |Prénom                                                                |
++-----------------------+----------------------------------------------------------------------+
+|lastname               |Nom                                                                   |
++-----------------------+----------------------------------------------------------------------+