diff --git a/admin_manual/configuration_user/user_provisioning_api.rst b/admin_manual/configuration_user/user_provisioning_api.rst
index 91b26eed4..4f49166fa 100644
--- a/admin_manual/configuration_user/user_provisioning_api.rst
+++ b/admin_manual/configuration_user/user_provisioning_api.rst
@@ -20,8 +20,8 @@ All POST requests require the ``Content-Type: application/x-www-form-urlencoded`
Instruction Set For Users
=========================
-**users / adduser**
--------------------
+Add a new user
+--------------
Create a new user on the Nextcloud server. Authentication is done by sending a
basic HTTP authentication header.
@@ -49,7 +49,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -61,8 +61,8 @@ XML Output
-**users / getusers**
---------------------
+Search/get users
+----------------
Retrieves a list of users from the Nextcloud server. Authentication is done by
sending a Basic HTTP Authorization header.
@@ -87,7 +87,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -102,8 +102,8 @@ XML Output
-**users / getuser**
--------------------
+Get data of a single user
+-------------------------
Retrieves information about a single user. Authentication is done by sending a
Basic HTTP Authorization header.
@@ -125,7 +125,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -134,14 +134,24 @@ XML Output
ok
- frank@example.org
- 0
true
+ Frank
+ 0
+ frank@example.org
+ Frank K.
+ 0123 / 456 789
+ Foobar 12, 12345 Town
+ https://nextcloud.com
+ Nextcloud
+
+ group1
+ group2
+
-**users / edituser**
---------------------
+Edit data of a single user
+--------------------------
Edits attributes related to a user. Users are able to edit email, displayname
and password; admins can also edit the quota value. Authentication is done by
@@ -150,7 +160,18 @@ sending a Basic HTTP Authorization header.
**Syntax: ocs/v1.php/cloud/users/{userid}**
* HTTP method: PUT
-* PUT argument: key, the field to edit (email, quota, display, password)
+* PUT argument: key, the field to edit:
+
+ + email
+ + quota
+ + displayname
+ + display (**deprecated** use `displayname` instead)
+ + phone
+ + address
+ + website
+ + twitter
+ + password
+
* PUT argument: value, the new value for the field
Status codes:
@@ -173,7 +194,7 @@ Examples
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -184,8 +205,8 @@ XML Output
-**users / disableuser**
------------------------
+Disable a user
+--------------
Disables a user on the Nextcloud server so that the user cannot login anymore.
Authentication is done by sending a Basic HTTP Authorization header.
@@ -208,7 +229,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -220,8 +241,8 @@ XML Output
-**users / enableuser**
-----------------------
+Enable a user
+-------------
Enables a user on the Nextcloud server so that the user can login again.
Authentication is done by sending a Basic HTTP Authorization header.
@@ -244,7 +265,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -256,8 +277,8 @@ XML Output
-**users / deleteuser**
-----------------------
+Delete a user
+-------------
Deletes a user from the Nextcloud server. Authentication is done by sending a
Basic HTTP Authorization header.
@@ -280,7 +301,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -291,8 +312,8 @@ XML Output
-**users / getgroups**
----------------------
+Get user´s groups
+-----------------
Retrieves a list of groups the specified user is a member of. Authentication is
done by sending a Basic HTTP Authorization header.
@@ -314,7 +335,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -330,8 +351,8 @@ XML Output
-**users / addtogroup**
-----------------------
+Add user to group
+-----------------
Adds the specified user to the specified group. Authentication is done by
sending a Basic HTTP Authorization header.
@@ -360,7 +381,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -371,8 +392,8 @@ XML Output
-**users / removefromgroup**
----------------------------
+Remove user from group
+----------------------
Removes the specified user from the specified group. Authentication is done by
sending a Basic HTTP Authorization header.
@@ -402,7 +423,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -413,8 +434,8 @@ XML Output
-**users / createsubadmin**
---------------------------
+Promote user to subadmin
+------------------------
Makes a user the subadmin of a group. Authentication is done by sending a Basic
HTTP Authorization header.
@@ -443,7 +464,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -454,8 +475,8 @@ XML Output
-**users / removesubadmin**
---------------------------
+Demote user from subadmin
+-------------------------
Removes the subadmin rights for the user specified from the group specified.
Authentication is done by sending a Basic HTTP Authorization header.
@@ -484,7 +505,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -495,8 +516,8 @@ XML Output
-**users / getsubadmingroups**
------------------------------
+Get user´s subadmin groups
+--------------------------
Returns the groups in which the user is a subadmin. Authentication is done by
sending a Basic HTTP Authorization header.
@@ -521,7 +542,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -538,8 +559,8 @@ XML Output
Instruction Set For Groups
==========================
-**groups / getgroups**
-----------------------
+Search/get groups
+-----------------
Retrieves a list of groups from the Nextcloud server. Authentication is done by
sending a Basic HTTP Authorization header.
@@ -564,7 +585,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -579,8 +600,8 @@ XML Output
-**groups / addgroup**
----------------------
+Create a group
+--------------
Adds a new group. Authentication is done by
sending a Basic HTTP Authorization header.
@@ -607,7 +628,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -618,8 +639,8 @@ XML Output
-**groups / getgroup**
----------------------
+Get members of a group
+----------------------
Retrieves a list of group members. Authentication is done by sending a Basic
HTTP Authorization header.
@@ -641,7 +662,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -656,8 +677,8 @@ XML Output
-**groups / getsubadmins**
--------------------------
+Get subadmins of a group
+------------------------
Returns subadmins of the group. Authentication is done by
sending a Basic HTTP Authorization header.
@@ -682,7 +703,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -696,8 +717,8 @@ XML Output
-**groups / deletegroup**
-------------------------
+Delete a group
+--------------
Removes a group. Authentication is done by
sending a Basic HTTP Authorization header.
@@ -721,7 +742,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -731,12 +752,12 @@ XML Output
-
-Instruction Set For Apps
-=========================
-**apps / getapps**
-------------------
+Instruction Set For Apps
+========================
+
+Getlist of apps
+---------------
Returns a list of apps installed on the Nextcloud server. Authentication is done
by sending a Basic HTTP Authorization
@@ -761,7 +782,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -777,8 +798,8 @@ XML Output
-**apps / getappinfo**
----------------------
+Get app info
+------------
Provides information on a specific application. Authentication is done by
sending a Basic HTTP Authorization header.
@@ -800,7 +821,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -831,8 +852,8 @@ XML Output
-**apps / enable**
------------------
+Enable an app
+-------------
Enable an app. Authentication is done by sending a Basic HTTP Authorization
header.
@@ -854,7 +875,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml
@@ -864,8 +885,8 @@ XML Output
-**apps / disable**
-------------------
+Disable an app
+--------------
Disables the specified app. Authentication is
done by sending a Basic HTTP Authorization header.
@@ -888,7 +909,7 @@ Example
XML Output
^^^^^^^^^^
-::
+.. code-block:: xml