OMomni
Document permissions

Update document permissions

Changed on

Update existing document permissions for users or groups.

patch/v1/documents/{documentId}/permissions

Request

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

Path parameters

documentIdstring required

The document identifier. To retrieve the ID, navigate to File > Document settings in the document and then click Settings. The Identifier field contains the document ID.

Request body

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

The content role to assign. Must be one of:

  • NO_ACCESS - No access. Document won't appear in content system or search results.
  • VIEWER - View dashboard
  • EDITOR - Edit dashboard and workbook
  • MANAGER - Edit dashboard and workbook and manage permissions
  • OWNER - Manager permissions and receives access requests. The document must have at least one owner at all times.
accessBoostboolean

If true, AccessBoost will be enabled for the document. 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 must be a non-empty list.

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 must be a non-empty list.

Example request

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

Response

Permissions updated successfully

successboolean

Example response

{
  "success": true
}

Changes