Skip to main content

Get file permission

POST /api/v1/files/{fileId}/permissions/{permId} HTTP/1.1
  1. Path parameters
ParameterDescription
fileIdThe ID of the file.
permIdThe user’s login or groupId.

Response structure​

PathTypeDescription
permissionObjectPermission object
links[]ArrayLinks for this permission
permission.idStringThe user’s login or groupId for this permission.
permission.emailStringThe user’s email for this permission
permission.fsPermIdStringThe user’s id or group’s id if it’s a group permission
permission.parentShareIdStringShared parent folder
permission.parentShareFilenameStringParent share filename
permission.shareUserFirstNameStringShare user first name
permission.shareUserLastNameStringShare user last name
permission.shareUserMiddleNameStringShare user middle name
permission.shareUserAvatarIdStringShare user avatar id
permission.roleStringThe primary role for this user/group
permission.isGroupBooleanGroup permission indicator
permission.groupNameStringPermission group name
permission.loginStringPermission user login
permission.isDeletedBooleanThe user was deleted
links[].relStringLink type
links[].hrefStringLink reference
  1. Example request
curl 'http://localhost:8080/api/v1/files/189379374/permissions/testsrvdocs2@tacos.devoffice.ru' -i -X GET \
-H 'X-co-auth-token: 325c10bc178bbdf951ab52d1b85b3811'
  1. Example response
HTTP/1.1 200 OK
X-co-request-id: 62426443314135556475375371674549
Content-Disposition: inline;filename=f.txt
Content-Type: application/vnd.ncloudtech.cloudoffice.permission+json;v=1;charset=UTF-8
Content-Length: 601
{
"permission": {
"id": "testsrvdocs2@tacos.devoffice.ru",
"email": "testsrvdocs2@tacos.devoffice.ru",
"fsPermId": "d97ad43a5bb14c7fa0564e637f0529d6",
"isGroup": false,
"login": "testsrvdocs2@tacos.devoffice.ru",
"role": "editor",
"shareUserAvatarId": "8bd73b29-b7a8-4adb-b703-0d005c235f80",
"shareUserFirstName": "a",
"shareUserLastName": "s",
"shareUserMiddleName": "d",
"isDeleted": false
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/api/v1/files/testsrvdocs2@tacos.devoffice.ru"
}
]
}