Use this operation to change the access permissions of individual users in a user group on a file or folder in a shared folder.
Request
Syntax
PUT <webservice>/contentstore/file/{fileOrfolderID}/permissions HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>
Content-type: application/xml
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Request Parameters
|
Name |
Description |
Required |
|---|---|---|
|
fileOrfolderID |
The GUID of the file or folder. GUID is a unique identifier for a file or folder and remains the same even when you rename or move the file or folder to another path. To retrieve the GUID of the file, see Viewing ObjectStore File or Folder Properties. |
Yes |
Request Body
Download the XML or JSON file required for this request: <update_adv_permissions_template.xml>. The following table displays the parameters for the request body.
|
Parameter |
Description |
Element |
|---|---|---|
|
opType |
Specifies the operation type. Valid values are:
|
Api_AddPermissionsReq |
|
allowPermissions |
Specifies the permissions that are allowed for the user. Valid values are:
|
permissions |
|
denyPermissions |
Specifies the permission that are denied to the user. Valid values are:
|
permissions |
|
userType |
Applies only to private shares. Specifies the type of entity to which the file or folder is being shared. Valid values are: 1 - user 2 - email address 3 - CommCell user group 4 - external AD user group |
userInfo |
|
userGroupId |
The system-generated ID assigned to the user group associated with the user. |
userGroup |
|
userGroupName |
The name of the user group associated with the user. |
userGroup |
|
externalGroupName |
Domain/username in an external group to which you want to set the permission. |
externalGroup |
|
val |
Permission assigned to the user. Use val =1 to assign view permission. Use val =2 to assign edit permission. |
allowPermissions |
|
userName |
Domain/username to which you want to set the permission. |
user |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
errorCode |
The possible error codes. Valid values are:
|
App_GenericResponse |
|
errorString |
The description of the error code. Not all error codes have an error message. |
App_GenericResponse |
Examples
Sample Request
PUT <webservice>/contentstore/file/83dd41f4d7b848429daf15b668ea5f9a/permissions HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
<Api_AddPermissionsReq opType="1"> <permissions> <userInfo userType="4"> <externalGroup externalGroupName="domainname\user1"/> </userInfo> <allowPermissions val="1"/> </permissions> <permissions> <userInfo userType="3"> <userGroup userGroupName="TestGroup"/> </userInfo> <allowPermissions val="1"/> </permissions> <permissions> <userInfo userType="3"> <userGroup userGroupName="TestGroup2"/> </userInfo> <denyPermissions val="1</permissions> <permissions> <userInfo userType="1"> <user userName="domainname\user2"/> </userInfo> <allowPermissions val="1"/> <allowPermissions val="2"/> </permissions> </Api_AddPermissionsReq>