OMomni
Folder permissions

Grant folder permissions

Changed on

Grant folder permissions to users or groups

post/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

role'NO_ACCESS' | 'VIEWER' | 'EDITOR' | 'MANAGER' | 'OWNER' required

The content role to assign to the specified users or user groups. Must be one of:

  • NO_ACCESS - No access
  • VIEWER - View folder contents
  • EDITOR - Edit and add content to the folder
  • MANAGER - Edit, add content, and manage folder permissions
  • OWNER - Manager permissions and receives access requests. The document must have at least one owner at all times.
accessBoostboolean

If true, AccessBoost is enabled for the folder. Setting this to false is always allowed. Setting this to true with a user-scoped API key requires that the organization's Non-administrators can enable AccessBoost on content setting is enabled and that the user has permission to enable AccessBoost, or the request returns a 403 error. Organization-scoped API keys are not subject to this check.

userIdsstring[]

The list of user IDs to assign permissions to. Use the List users and List embed users endpoints to retrieve user IDs. Either userIds or userGroupIds is required.

userGroupIdsstring[]

The list of user group IDs to assign permissions to. Use the List user groups endpoint to retrieve user group IDs. Either userIds or userGroupIds is required.

Example request

{
  "role": "EDITOR",
  "userIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "userGroupIds": [
    "mEhXj6ZI"
  ]
}

Response

Permissions granted successfully

successboolean

Example response

{
  "success": true
}

Changes