The Get Folder Permissions API retrieves all permissions for a the specified folder. The response contains group-level and user-level permissions.
Resource Location
GET /v1/services/workspaces/permissions/folders
Authorization Type
HTTP Cookie ssoGlobalSessionID
Request Parameters
Name | Description | Required | Example |
---|---|---|---|
method | Intralinks call method. Must be set to GET |
Yes | method=GET |
workspaceId | Integer identifier of the target exchange | Yes | &workspaceId=123789 |
folderId | Integer identifier of the target folder | No | &folderId=456 |
includeUserPermission | Include implicit user-level permissions. | No | &includeUserPermission=true |
Example Request
curl -k -X GET
-b "ssoGlobalSessionID=SESSION_ID"
"https://test-api.intralinks.com/v1/services/workspaces/permissions/folders?method=GET&client=YOUR_CLIENT_ID&workspaceId=12345&folderId=456&includeUserPermission=true"
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<folderPermissionsResponse>
<status>
<code>200</code>
<message>Request completed fine, no errors</message>
</status>
<workspaceContext>
<lastModifiedOn>
<milliseconds>1274044488000</milliseconds>
</lastModifiedOn>
<settingsLastModifiedOn>
<milliseconds>1274044489000</milliseconds>
</settingsLastModifiedOn>
<userLastModifiedOn>
<milliseconds>1273785116000</milliseconds>
</userLastModifiedOn>
</workspaceContext>
<permissions>
<nonPermissioned>
<permissionInfo>
<drm>NONE</drm>
<granteeInfo>
<createAllowed>F</createAllowed>
<!--this means creation of documents is allowed within this folder-->
<granteeId>2501741</granteeId>
<granteeType>WORKSPACE</granteeType>
<groupName>WSGroup</groupName>
<isWorkspaceUser>F</isWorkspaceUser>
</granteeInfo>
<isInherited>F</isInherited>
<!--is this permission coming from the parent folder-->
</permissionInfo>
</nonPermissioned>
<permissioned>
<permissionInfo>
<drm>NOSAVE</drm>
<granteeInfo>
<createAllowed>T</createAllowed>
<granteeId>2501751</granteeId>
<granteeType>BUYER</granteeType>
<groupName>BuyerGroup</groupName>
<isWorkspaceUser>F</isWorkspaceUser>
</granteeInfo>
<isInherited>F</isInherited>
<permission>SEE</permission>
<seeOnly>T</seeOnly>
</permissionInfo>
</permissioned>
</permissions>
</folderPermissionsResponse>