# Task OP-11979 - Investigate Nextcloud API Project: OpenProject Status: closed URL: https://community.openproject.org/work_packages/OP-11979 ## Details | Attribute | Value | | --- | --- | | Assignee | | | Date | 2022-06-10 – | | Priority | Medium | | Target versions | 13.0.0 | | Category | | | Labels | | ## Description Check what permission can be set and changed through the API - Check if the API is usable as we intend API parts to check: - [x] Access control on group folders - [x] Membership management of a specific group - [x] Get ID of group by name *OpenProject* - [x] Complexity of certain requests (e.g. delete all permissions, readd all permissions) - [x] Check file(s) info endpoint for getting path of folder ID - [x] Check if group admin can add users to their group Acceptance Criteria: - [x] list of curl commands # Findings ## User/Group Provisioning ### Get groups: Request: ``` curl curl --request GET \ --url 'https://nextcloud.local/ocs/v1.php/cloud/groups?search=OpenProject' \ --header 'Authorization: Basic YWRtaW46amR6ZUwtM1Q0TVMta1BYcHQtcDg5WUItWFRKMmY=' \ --header 'OCS-APIRequest: true' ``` Response: ``` xml ok 100 OK OpenProject ``` ### Add user to a group: Request: ``` curl curl -u 'OpenProject:wKWyg-ZbypL-xx6co-WtA4X-bLyJS' \ --request POST \ --url https://nextcloud.local/ocs/v1.php/cloud/users/TestUser/groups \ -d groupid="OpenProject" \ --header 'OCS-APIRequest: true' ``` Response: ``` xml ok 100 OK ``` ### Remove user from a group: Request: ``` curl curl -u 'OpenProject:wKWyg-ZbypL-xx6co-WtA4X-bLyJS' \ --request DELETE \ --url https://nextcloud.local/ocs/v1.php/cloud/users/TestUser/groups \ -d groupid="OpenProject" \ --header 'OCS-APIRequest: true' ``` Response: ``` xml ok 100 OK ``` ## **Group Folder Permissions** ### Get group folders: Request: ``` curl curl --request GET \ --url https://nextcloud.local/index.php/apps/groupfolders/folders \ --header 'Accept: application/json' \ --header 'Authorization: Basic YWRtaW46amR6ZUwtM1Q0TVMta1BYcHQtcDg5WUItWFRKMmY=' \ --header 'OCS-APIRequest: true' ``` Response: ``` json { "ocs": { "meta": { "status": "ok", "statuscode": 100, "message": "OK", "totalitems": "", "itemsperpage": "" }, "data": { "2": { "id": 2, "mount_point": "OpenProject", "groups": { "OpenProject": 31 }, "quota": -3, "size": 1109861, "acl": true, "manage": [ { "type": "user", "id": "OpenProject", "displayname": "OpenProject" } ] } } } } ``` ### Get specific group folder: Request: ``` curl curl --request GET \ --url https://nextcloud.local/index.php/apps/groupfolders/folders/2 \ --header 'Accept: application/json' \ --header 'Authorization: Basic YWRtaW46amR6ZUwtM1Q0TVMta1BYcHQtcDg5WUItWFRKMmY=' \ --header 'OCS-APIRequest: true' ``` Response: ``` json { "ocs": { "meta": { "status": "ok", "statuscode": 100, "message": "OK", "totalitems": "", "itemsperpage": "" }, "data": { "id": 2, "mount_point": "OpenProject", "groups": { "OpenProject": 31 }, "quota": -3, "size": 989753, "acl": true, "manage": [ { "type": "user", "id": "OpenProject", "displayname": "OpenProject" } ] } } } ``` ### Fetching ACLs for a folder: Request: ``` curl curl --request PROPFIND \ --url https://nextcloud.local/remote.php/dav/files/OpenProject/OpenProject \ --header 'Authorization: Basic T3BlblByb2plY3Q6Q240WDUtZGdzWkYtdGpHd0otMm9TbmUtVHBFQXM=' \ --data ' ' ``` Response: ``` xml /remote.php/dav/files/OpenProject/OpenProject/ user OpenProject OpenProject 0 31 group OpenProject OpenProject 31 1 HTTP/1.1 200 OK /remote.php/dav/files/OpenProject/OpenProject/Project%20A/ user OpenProject OpenProject 31 31 group OpenProject OpenProject 31 0 user andreas Andreas 0 31 user member Member 0 31 HTTP/1.1 200 OK /remote.php/dav/files/OpenProject/OpenProject/Project%20B/ user OpenProject OpenProject 31 31 group OpenProject OpenProject 31 0 user andreas Andreas 0 31 HTTP/1.1 200 OK ``` ### Change ACLs for group folder ACLs: Request: ``` curl curl --request PROPPATCH \ --url https://nextcloud.local/remote.php/dav/files/admin/OpenProject/Project%20A/minecraft.jpg \ --header 'Authorization: Basic YWRtaW46amR6ZUwtM1Q0TVMta1BYcHQtcDg5WUItWFRKMmY=' \ --cookie 'ocg9pf67mryk=0077397d951ff6f1bba3372173b62abf; oc_sessionPassphrase=aYYxLxv1kAmhMLqw0vy1nqPw1Byf0%252Bf9UYHIYOScr8oTaff9NU2Vt7a6A0cv6ArG0CsJM4oJEOhn6KdFKYx8k3PJtfDGbkDj1tMcAwWopgZHx1Zp5tpG02%252Br5auo0rR1; __Host-nc_sameSiteCookielax=true; __Host-nc_sameSiteCookiestrict=true' \ --data ' user OpenProject 31 31 group OpenProject 31 0 user andreas 31 31 ' ``` Response: ``` xml /remote.php/dav/files/OpenProject/OpenProject/Project%20A/minecraft.jpg HTTP/1.1 200 OK ```