khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #364 from nextcloud/user-metadata

Browse Source 
document user metadata
This commit is contained in:
Morris Jobke
2017-02-24 12:29:42 -06:00
committed by GitHub
parent 02dea61504 46b3bd3ee7
commit 4912deca91
2 changed files with 80 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
developer_manual/client_apis/OCS/index.rst Normal file
View File

@@ -0,0 +1,67 @@
.. _webdavindex:
=========
OCS API's
=========
This document provides a quick overview of the OCS API endpoints supported in Nextcloud.
All requests need to provide authentication information, either as a Basic Auth header or by passing a set of valid session cookies, if not stated otherwise.
----
Testing requests with curl
----
All OCS requests can be easily tested out using :code:`curl` by specifying the request method (:code:`GET`, :code:`PUT`, etc) and setting a request body where needed.
For example: you can perform a :code:`GET` request to get information about a user:
.. code-block:: bash
curl -u username:password -X GET 'https://cloud.example.com/ocs/v1.php/...' -H "OCS-APIRequest: true"
-------------
User metadata
-------------
Since: 11.0.2, 12.0.0
This request returns the available metadata of a user. Admin users can see the information of all users, while a default user only can access it's own metadata.
.. code::
GET /ocs/v1.php/cloud/users/USERID
.. code:: xml
<?xml version="1.0"?>
<ocs>
<meta>
<status>ok</status>
<statuscode>100</statuscode>
<message>OK</message>
<totalitems></totalitems>
<itemsperpage></itemsperpage>
</meta>
<data>
<enabled>true</enabled>
<quota>
<free>338696790016</free>
<used>7438874</used>
<total>338704228890</total>
<relative>0</relative>
<quota>-3</quota>
</quota>
<email>user@foo.de</email>
<displayname>admin</displayname>
<phone></phone>
<address></address>
<webpage></webpage>
<twitter>schiessle</twitter>
</data>
</ocs>

13
developer_manual/client_apis/index.rst
View File

@@ -14,9 +14,22 @@ WebDAV is the main api for file related operations, it supports listing director
An overview of how to use the various WebDAV api's can be found at :doc:`WebDAV/index`
---
OCS
---
The OCS API provides all information that are not available via the DAV endpoints. This contains endpoints for user data or sharing capabilities for example. See :doc:`OCS/index` for more details.
Other OCS API documentations:
* `Notifications API <https://github.com/nextcloud/notifications/blob/master/docs/ocs-endpoint-v2.md>`_
* `Notifications API - Register a device for push notifications <https://github.com/nextcloud/notifications/blob/5a2d3607952bad675e4057620a9c7de8a7f84f0b/docs/push-v3.md>`_
.. toctree::
:maxdepth: 2
:hidden:
webdav/index
ocs/index