From 60d2bfc53896b4c6d64aeca35d5b39d3779c6af6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Markus=20M=C3=A4kel=C3=A4?= Date: Tue, 25 Jun 2019 08:29:44 +0300 Subject: [PATCH] Update REST-API documentation The /users/inet endpoint now supports PATCH. --- Documentation/REST-API/Resources-User.md | 28 ++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/Documentation/REST-API/Resources-User.md b/Documentation/REST-API/Resources-User.md index f10546cfe..67d0095ae 100644 --- a/Documentation/REST-API/Resources-User.md +++ b/Documentation/REST-API/Resources-User.md @@ -282,3 +282,31 @@ The _:name_ part of the URI must be a valid user name. ``` Status: 204 No Content ``` + +### Update a network user + +``` +PATCH /v1/users/inet/:name +``` + +Update network user. Currently, only the password can be updated. This +means that the request body must define the `data.attributes.password` +field. + +Here is an example request body that updates the password. + +```javascript +{ + "data": { + "attributes": { + "password": "new-password" + } + } +} +``` + +#### Response + +``` +Status: 204 No Content +```