Folder permissions

Update organization-level folder permissions

Changed on

Set the role every member of the organization holds on a folder, and/or turn AccessBoost on or off for that organization-wide access, without naming individual users or groups. The role cascades to every descendant folder and document, so a single call can re-permission an entire folder tree.

At least one of organizationRole or organizationAccessBoost is required.

put/v1/folders/{folderId}/permissions

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/folders/{folderId}/permissions
  • Auth
    HTTP bearer

Path parameters

folderIdstring uuid required

The UUID of the folder. Use the List folders endpoint to retrieve folder IDs.

Request body

organizationAccessBoostboolean

Whether everyone in the organization gets AccessBoost on this folder. Setting this to true requires an organization role that grants access, either sent in the same request or already on the folder; otherwise the request is rejected.

organizationRole'NO_ACCESS' | 'VIEWER' | 'EDITOR' | 'MANAGER' | 'OWNER'

The role every member of the organization holds on the folder. Must be one of NO_ACCESS, VIEWER, EDITOR, or MANAGER. OWNER cannot be granted at the organization level. Pass null to clear the organization role.

Response

Permission settings updated successfully

successboolean required

Whether the permission settings were updated successfully

Changes