List Folder Permissions

Overview

This operation returns the list of permissions on a folder for the user (or their roles). The list includes permissions which are inherited from the parent folders.

If a path of a folder is specified on which the user does not have permissions, the service returns empty permission for that folder.

The available permissions can be READ or WRITE.

ACL Authorization Flow

The user making this request will get permissions only on those resources on which user has at least READ permission.

HTTP GET URL Format

The following format is used for HTTP GET requests to list the folder permissions for all the folders:

HTTP GET http://<server>:<port>/rest/Spatial/AccessControlService/permissions/folders

The following format is used for HTTP GET requests to list the folder permissions for the specified folder:

HTTP GET http://<server>:<port>/rest/Spatial/AccessControlService/permissions/folders/repositoryFolderPath

Parameters


Parameter	Type	Required	Description
repositoryFolderPath	String	No	Specifies the path of the repository folder for which the permissions are to be listed.

HTTP POST URL Format

The following format is used for HTTP POST requests:

HTTP POST URL: /permissions/folders
POST BODY: {
   "resources":[
      "/Samples/NamedTables/",
      "/Samples/NamedMaps/"
   ]
} 
POST HEADER: Content-Type:application/json

Returns

Returns the list of folders a user (or their roles) has permissions on.

Example for GET

Request URL

http://<server>:<port>/rest/Spatial/AccessControlService/permissions/folders/Samples/NamedLayers/

Response

{
   "name":"/Samples/NamedLayers/",
   "permissions":[
      "READ",
      "WRITE"
   ]
}

Example for POST

Request URL

http://<server>:<port>/rest/Spatial/AccessControlService/permissions/folders/

Request Body

{
   "resources":[
      "/Samples/NamedTables/",
      "/Samples/NamedMaps/"
   ]
}

Response

{
   "resourcePermissions":[
      {
         "name":"/Samples/NamedTables/",
         "permissions":[
            "READ",
            "WRITE"
         ]
      },
      {
         "name":"/Samples/NamedMaps/",
         "permissions":[
            "READ",
            "WRITE"
         ]
      }
   ]
}