From af4533eaf3f1dfbc3dfab9bc3f19aaae8d098dd9 Mon Sep 17 00:00:00 2001 From: m7913d <84547986+m7913d@users.noreply.github.com> Date: Mon, 24 May 2021 17:51:01 +0200 Subject: [PATCH 1/3] Documented changing display name of group This instruction was already added to nextcloud in 2019, see commit https://github.com/nextcloud/server/commit/653628c8fb69dc3f9d26751520f91e43a18f17ae Signed-off-by: Dries Mys --- .../instruction_set_for_groups.rst | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/admin_manual/configuration_user/instruction_set_for_groups.rst b/admin_manual/configuration_user/instruction_set_for_groups.rst index 86b63feb5..f1c2e44d0 100644 --- a/admin_manual/configuration_user/instruction_set_for_groups.rst +++ b/admin_manual/configuration_user/instruction_set_for_groups.rst @@ -166,6 +166,49 @@ XML output +Edit data of a single group +-------------------------- + +Edits attributes related to a group. Authentication +is done by sending a Basic HTTP Authorization header. + +**Syntax: ocs/v1.php/cloud/groups/{groupid}** + +* HTTP method: PUT +* PUT argument: key, the field to edit: + + + displayname + +* PUT argument: value, the new value for the field + +Status codes: + +* 100 - successful +* 101 - not supported by backend + +Examples +^^^^^^^^ + +:: + + $ curl -X PUT http://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup -d key="displayname" -d value="My Group Name" + +* Updates the display name for the group ``mygroup`` + +XML output +^^^^^^^^^^ + +.. code-block:: xml + + + + + 100 + ok + + + + Delete a group -------------- From 752ef5d09bcb5b399df0ccce54f97da97917f5f2 Mon Sep 17 00:00:00 2001 From: m7913d <84547986+m7913d@users.noreply.github.com> Date: Tue, 1 Jun 2021 23:33:09 +0200 Subject: [PATCH 2/3] Documenting type of key and value Co-authored-by: Joas Schilling <213943+nickvergessen@users.noreply.github.com> Signed-off-by: Dries Mys --- .../configuration_user/instruction_set_for_groups.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/admin_manual/configuration_user/instruction_set_for_groups.rst b/admin_manual/configuration_user/instruction_set_for_groups.rst index f1c2e44d0..d991b3e4c 100644 --- a/admin_manual/configuration_user/instruction_set_for_groups.rst +++ b/admin_manual/configuration_user/instruction_set_for_groups.rst @@ -175,11 +175,11 @@ is done by sending a Basic HTTP Authorization header. **Syntax: ocs/v1.php/cloud/groups/{groupid}** * HTTP method: PUT -* PUT argument: key, the field to edit: +* PUT argument: key, string - the field to edit: + displayname -* PUT argument: value, the new value for the field +* PUT argument: value, string - the new value for the field Status codes: From d0e471fe6332321e15388e6b2c6a9520bf42ba4c Mon Sep 17 00:00:00 2001 From: m7913d <84547986+m7913d@users.noreply.github.com> Date: Mon, 9 May 2022 23:57:06 +0200 Subject: [PATCH 3/3] Improved formatting Co-authored-by: Joas Schilling <213943+nickvergessen@users.noreply.github.com> Signed-off-by: Dries Mys --- admin_manual/configuration_user/instruction_set_for_groups.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/admin_manual/configuration_user/instruction_set_for_groups.rst b/admin_manual/configuration_user/instruction_set_for_groups.rst index d991b3e4c..9e4ed39ee 100644 --- a/admin_manual/configuration_user/instruction_set_for_groups.rst +++ b/admin_manual/configuration_user/instruction_set_for_groups.rst @@ -167,7 +167,7 @@ XML output Edit data of a single group --------------------------- +--------------------------- Edits attributes related to a group. Authentication is done by sending a Basic HTTP Authorization header.