From 197e78e71767ec38befd6cc097cf033fc2b4c802 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benedikt=20Gei=C3=9Fler?= Date: Thu, 10 Nov 2016 18:13:24 +0100 Subject: [PATCH] Add documentation for enabling and disabling users via the Nextcloud provisioning API --- .../user_provisioning_api.rst | 72 +++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/admin_manual/configuration_user/user_provisioning_api.rst b/admin_manual/configuration_user/user_provisioning_api.rst index e008c6460..3784358e8 100644 --- a/admin_manual/configuration_user/user_provisioning_api.rst +++ b/admin_manual/configuration_user/user_provisioning_api.rst @@ -182,6 +182,78 @@ XML Output +**users / disableuser** +---------------------- + +Disables a user on the Nextcloud server so that the user cannot login anymore. +Authentication is done by sending a Basic HTTP Authorization header. + +**Syntax: ocs/v1.php/cloud/users/{userid}/disable** + +* HTTP method: PUT + +Statuscodes: + +* 100 - successful +* 101 - failure + +Example +^^^^^^^ + + * PUT ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/disable`` + * Disables the user ``Frank`` + +XML Output +^^^^^^^^^^ + +:: + + + + + ok + 100 + + + + + +**users / enableuser** +---------------------- + +Enables a user on the Nextcloud server so that the user can login again. +Authentication is done by sending a Basic HTTP Authorization header. + +**Syntax: ocs/v1.php/cloud/users/{userid}/enable** + +* HTTP method: PUT + +Statuscodes: + +* 100 - successful +* 101 - failure + +Example +^^^^^^^ + + * PUT ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/enable`` + * Enables the user ``Frank`` + +XML Output +^^^^^^^^^^ + +:: + + + + + ok + 100 + + + + + **users / deleteuser** ----------------------