.. _reference-cli-client-user-list:

#######################
Lister les utilisateurs
#######################

.. program:: waarp-transfer user list

Affiche une liste de tous les utilisateurs remplissant les critères ci-dessous.

**Commande**

.. code-block:: shell

   waarp-transfer user list

**Options**

.. option:: -l <LIMIT>, --limit=<LIMIT>

   Le nombre maximum d'utilisateurs autorisés dans la réponse. Fixé à 20 par défaut.

.. option:: -o <OFFSET>, --offset=<OFFSET>

   Le numéro du premier utilisateur renvoyé.

.. option:: -s <SORT>, --sort=<SORT>

   Le paramètre et l'ordre selon lesquels les utilisateurs seront affichés. Les
   choix possibles sont:

   - par nom d'utilisateur (``username+`` & ``username-``)

.. option:: --format=<FORMAT>

   Spécifie le format du retour de la commande. Les valeurs acceptées sont :
   ``human``, ``json`` et ``yaml``. Par défaut, le format sera le format pour
   humain (``human``).

|

**Exemple**

.. code-block:: shell

   waarp-transfer -a 'http://user:password@localhost:8080' user list -l 10 -o 5 -s 'username+'
