Lister les utilisateurs

GET /api/users

Renvoie une liste des utilisateurs remplissant les critères donnés en paramètres de requête.

En-têtes de requête:
Paramètres:

  • limit (int) – Le nombre maximum de résultats souhaités (défaut: 20)

  • offset (int) – Le numéro du premier résultat souhaité (défaut: 0)

  • sort ([username+|username-]) – Le paramètre selon lequel les utilisateurs seront triés (défaut: username+)

Status Codes:

  • 200 OK – La liste a été renvoyée avec succès

  • 400 Bad Request – Un ou plusieurs des paramètres de requêtes sont invalides

  • 401 Unauthorized – Authentification d’utilisateur invalide

Objet JSON de réponse:

  • users (array) – La liste des utilisateur demandés

Tableau d’objets JSON de réponse:

  • username (string) – Le nom de l’utilisateur

Resjsonerr object perms:

Les droits de l’utilisateur. Chaque attribut correspond à un élément sur lequel l’utilisateur peut agir, et leur valeur indique les actions autorisées. Les différentes actions possibles sont lecture (r), écriture (w) et suppression (d). Ces droits sont renseignés avec une syntaxe similaire à chmod où l’autorisation d’exécution a été remplacée par la suppression.

  • transfers (string) - Les droits sur les transferts. (Note:

    les transferts ne peuvent pas être supprimés).

  • servers (string) - Les droits sur les serveurs locaux.

  • partners (string) - Les droits sur les partenaires distants.

  • rules (string) - Les droits sur les règles de transfert.

  • users (string) - Les droits sur les autres utilisateurs.

Exemple de requête

GET https://my_waarp_gateway.net/api/users?limit=10&sort=username- HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 76

{
  "users": [{
    "username": "tutu",
    "perms": {
      "transfers":"r--",
      "servers":"rw-",
      "partners":"rw-",
      "rules":"---",
      "users":"---"
    }
  },{
    "username": "toto",
    "perms": {
      "transfers":"rw-",
      "servers":"r--",
      "partners":"r--",
      "rules":"rwd",
      "users":"---"
    }
  }]
}