diff options
| author | blizzz <blizzz@arthur-schiwon.de> | 2022-07-20 00:53:39 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-20 00:53:39 +0300 |
| commit | 2ec143ef893a254a58af13339e27851936a18126 (patch) | |
| tree | 2f9722bee47e4aa5bf771461768e5efa7bf435dd /admin_manual | |
| parent | 28e231f087509f9384471537dc3dff58e2146f28 (diff) | |
| parent | d0e471fe6332321e15388e6b2c6a9520bf42ba4c (diff) | |
Merge pull request #6721 from m7913d/addUpdateGroup
Documented changing display name of group
Diffstat (limited to 'admin_manual')
| -rw-r--r-- | admin_manual/configuration_user/instruction_set_for_groups.rst | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/admin_manual/configuration_user/instruction_set_for_groups.rst b/admin_manual/configuration_user/instruction_set_for_groups.rst index 86b63feb5..9e4ed39ee 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 </data> </ocs> +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, string - the field to edit: + + + displayname + +* PUT argument: value, string - 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 + + <?xml version="1.0"?> + <ocs> + <meta> + <statuscode>100</statuscode> + <status>ok</status> + </meta> + <data/> + </ocs> + Delete a group -------------- |