Endpoint: /sites/{siteId}/filesystem/folders/{folderid}/permissions/{folderpermid}

Returns, updates, and deletes permissions on folder

GET
PATCH
DELETE

Method & URL

GET https://[server URL]:[port]/admin/v2/sites/{siteId}/filesystem/folders/{folderid}/permissions/{folderpermid}

GET Body Sample

Copy

# get the permissions for a specific folder
#
###
GET https://{{host}}/admin/v2/sites/{{Siteid}}/filesystem/folders/%2Fusr%2Fdyelacic%2Fsunroom%2F/permissions/user-04dcfd20-fc73-41d0-a0d8-62d1706e6281 HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

GET Response Body Sample

Copy

{ "data": { "attributes": { "canAppendFile": true, "canCreateSubfolder": true, "canDeleteFile": true, 
"canDeleteSubfolder": true, "canDownloadFile": false, "canList": true, "canRenameFileOrSubfolder": true, 
"canSeeHiddenFileOrSubfolder": true, "canSeeInParentList": true, "canSeeReadOnlyFileOrSubfolder": true, 
"canUploadFile": true }, "links": { "self": "/Admin/v2/sites/f1e58e70-926f-4786-877b-cf62abfdf0db/
filesystem/folders/%252Fusr%252Fdyelacic%252Fsunroom%252F/permissions/
user-04dcfd20-fc73-41d0-a0d8-62d1706e6281" }, "relationships": { "trustee": { "data": 
{ "id": "04dcfd20-fc73-41d0-a0d8-62d1706e6281", "meta": { "name": "dyelacic" }, "type": "user" }, 
"links": { "related": "/Admin/v2/sites/f1e58e70-926f-4786-877b-cf62abfdf0db/users/
04dcfd20-fc73-41d0-a0d8-62d1706e6281" } } }, "type": "folderPermissions" } }

GET PowerShell Sample

Copy

# get the folders permission
# get filesystem folders permissions
Write-Output "filesystem folders permissions"
Write-Output "-----"
$folderList = Invoke-RestMethod -Uri 
"$baseURL/v2/sites/$siteID/filesystem/folders/%2Fusr%2Fdyelacic%2fsunroom%2f/
permissions/user-04dcfd20-fc73-41d0-a0d8-62d1706e6281" -Method 'GET' -Headers $authHeader
Write-Output $folderList | ConvertTo-Json
foreach ($user in $folderList.data)
{
    Write-Output ("User $($user.id): $($user.attributes.loginName)")
}

Method & URL

PATCH https://[server URL]:[port]/admin/v2/sites/{siteId}/filesystem/folders/{folderid}/permissions/{folderpermid}

PATCH Body Sample

Copy

# change / update folder permissions
###
PATCH https://{{host}}/admin/v2/sites/{{Siteid}}/filesystem/folders/
%2Fusr%2Fdyelacic%2Fsunroom%2F/permissions/user-04dcfd20-fc73-41d0-a0d8-62d1706e6281 HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

{
  "data": {
    "type": "folderPermissions",
    "attributes": {
      "canUploadFile": false,
      "canDownloadFile": true,
      "canDeleteFile": false,
      "canRenameFileOrSubfolder": true,
      "canAppendFile": true,
      "canDeleteSubfolder": false,
      "canCreateSubfolder": true,
      "canSeeHiddenFileOrSubfolder": true,
      "canSeeReadOnlyFileOrSubfolder": true,
      "canSeeInParentList": true,
      "canList": true
    }
  }  
}
###

PATCH Response Body Sample

Copy

{ "data": { "attributes": { "canAppendFile": true, "canCreateSubfolder": true, 
"canDeleteFile": false, "canDeleteSubfolder": false, "canDownloadFile": true, 
"canList": true, "canRenameFileOrSubfolder": true, "canSeeHiddenFileOrSubfolder": true, 
"canSeeInParentList": true, "canSeeReadOnlyFileOrSubfolder": true, "canUploadFile": false }, 
"links": { "self": "/Admin/v2/sites/f1e58e70-926f-4786-877b-cf62abfdf0db/filesystem/
folders/%252Fusr%252Fdyelacic%252Fsunroom%252F/permissions/
user-04dcfd20-fc73-41d0-a0d8-62d1706e6281" }, "relationships": { "trustee": { "data": 
{ "id": "04dcfd20-fc73-41d0-a0d8-62d1706e6281", "meta": { "name": "dyelacic" }, 
"type": "user" }, "links": { "related": "/Admin/v2/sites/f1e58e70-926f-4786-877b-cf62abfdf0db/
users/04dcfd20-fc73-41d0-a0d8-62d1706e6281" } } }, "type": "folderPermissions" } }

PATCH PowerShell Sample

Copy

# change folder permissions
$update = 
'{
  "data": {
    "type": "folderPermissions",
    "attributes": {
      "canUploadFile": false,
      "canDownloadFile": true,
      "canDeleteFile": false,
      "canRenameFileOrSubfolder": true,
      "canAppendFile": true,
      "canDeleteSubfolder": false,
      "canCreateSubfolder": true,
      "canSeeHiddenFileOrSubfolder": true,
      "canSeeReadOnlyFileOrSubfolder": true,
      "canSeeInParentList": true,
      "canList": true
    }
  }  
}'
$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 30
# change folder permissions
Write-Output "change folder permissions"
Write-Output "-----"
$folderList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/
filesystem/folders/%2fusr%2fdyelacic%2ftuneroom%2f/permissions/
user-04dcfd20-fc73-41d0-a0d8-62d1706e6281" -Method 'PATCH' 
-Headers $authHeader -Body $update
Write-Output $folderList | ConvertTo-Json
foreach ($user in $folderList.data)
{
    Write-Output ("User $($user.id): $($user.attributes.loginName)")
}

Method & URL

DELETE https://[server URL]:[port]/admin/v2/sites/{siteId}/filesystem/folders/{folderid}/permissions/{folderpermid}

DELETE Body Sample

Copy

# delete folder permissions

###
DELETE https://{{host}}/admin/v2/sites/{{Siteid}}/filesystem/folders/
%2Fusr%2Fdyelacic%2Fsunroom%2F/permissions/
user-04dcfd20-fc73-41d0-a0d8-62d1706e6281 HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

DELETE Response Body Sample

Copy

HTTP/1.1 204 No Content Date: Fri, 11 Feb 2022 22:06:08 GMT Content-Length: 0 
Cache-Control: no-cache, no-store, must-revalidate Expires: -1 
X-Content-Type-Options: nosniff X-XSS-Protection: 1; mode=block 
Content-Security-Policy: default-src 'self' 'unsafe-inline' 'unsafe-eval' data:; 
Referrer-Policy: no-referrer

DELETE PowerShell Sample

Copy

#
# delete folder permissions

Write-Output "delete folders permissions"
Write-Output "-----"
$folderList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/filesystem/
folders/%2Fusr%2Fdyelacic%2ftuneroom%2f/permissions/user-04dcfd20-fc73-41d0-a0d8-62d1706e6281" 
-Method 'DELETE' -Headers $authHeader
Write-Output $folderList | ConvertTo-Json
foreach ($user in $folderList.data)
{
    Write-Output ("User $($user.id): $($user.attributes.loginName)")
}