Get User Folder Permission

Prev Next

This tutorial demonstrates how to get user folder permission via RESTful API.

The steps include:

  • Getting a user folder permission using the folder ID

The commands are provided in curl and can be run from the command prompt when the Synergy Server is running (or in a batch script).

Additional API documentation

To get a list of most of the API requests available, with the 12d Synergy server running, browse http://synergy.myserver.com/api-docs/ui/index.

(Replace synergy.myserver.com with the external server address and update the port numbers if necessary.)

1.1. Getting the Personal Access Token to access API

The tutorial for getting the PAT is here: Generate PAT in Web client.

1.2. Get Folder by ID

This request can be found in the API documentation under Folders marked 'Get user folder permission'

Sample Request

curl --location 'http://{your-server-here}/api/v1/folders/{folder-id}/permission' \

--header 'Authorization: Bearer <your-token-here>' \

--header 'Content-Type: application/json'

Below is a sample response for a specific folder.

Sample Response

{

    "can_report": true,

    "can_create_folders": true,

    "can_create_files": true,

    "admin": true,

    "can_view": true,

    "can_read": true,

    "can_write": true,

    "can_leave_notes": true,

    "can_update_attributes": true

}