Set Advanced Permissions on a File or Folder in Edge Drive (REST API: PUT)

Use this operation to change the access permissions of individual users in a user group on a file or folder in a shared folder in Edge Drive.

Request

Syntax

PUT webservice/drive/file/fileOrfolderId/permissions HTTP/1.1
Host: host name
Accept: application/xml | application/json
Authtoken: authentication token

Content-type: application/xml

 
<update_adv_permissions_template.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 File or Folder Properties.	Yes

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 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: 1 - add advanced permissions 2 - overwrite existing permissions.	Api_AddPermissionsReq
allowPermissions	Specifies the permissions that are allowed for the user. Valid values are: 1 -view permissions 2 - view and edit permissions	permissions
denyPermissions	Specifies the permission that are denied to the user. Valid values are: 1 -view permissions 2 -view and edit permissions	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: 0, successful completion. 2, a failure. a specific error code.	App_GenericResponse
errorString	The description of the error code. Not all error codes have an error message.	App_GenericResponse

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

0, successful completion.
2, a failure.
a specific error code.

App_GenericResponse

errorString

The description of the error code. Not all error codes have an error message.