Modifier un utilisateur¶
- PATCH /api/users/(string: username)¶
Met à jour l’utilisateur demandé avec les informations renseignées en JSON. Les champs non-spécifiés resteront inchangés.
- Request Headers
Authorization – Les identifiants de l’utilisateur
- Request JSON Object
username (string) – Le nom de l’utilisateur
password (string) – Le mot de passe de l’utilisateur
perms (object) –
Les droits de l’utilisateur. Chaque attribut correspond à un élément sur lequel l” utilisateurs 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. Les opérateurs de changement d’état + et - peuvent également être utilisés pour ajouter ou retirer un type de droit aux droits courants, et l’opérateur = pour les écraser.
- 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.
- Status Codes
201 Created – L’utilisateur a été remplacé avec succès
400 Bad Request – Un ou plusieurs des paramètres de l’utilisateur sont invalides
401 Unauthorized – Authentification d’utilisateur invalide
404 Not Found – L’utilisateur demandé n’existe pas
- Response Headers
Location – Le chemin d’accès à l’utilisateur modifié
Exemple de requête
PATCH https://my_waarp_gateway.net/api/users/toto HTTP/1.1 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== Content-Type: application/json Content-Length: 163 { "username": "toto_new", "password": "titi_new", "perms": { "transfers":"-w", "servers":"=rw-", "partners":"+w", "rules":"-wd", "users":"+rw" } }
Exemple de réponse
HTTP/1.1 201 CREATED Location: https://my_waarp_gateway.net/api/users/toto_new