OMomni
Document permissions

Revoke document permissions

Revoke document permissions for users or user groups.

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

userIdsstring[]

The list of user IDs to revoke permissions from. 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 revoke permissions from. Use the List user groups endpoint to retrieve user group IDs. Either userIds or userGroupIds must be a non-empty list.

Example request

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

Response

Permissions revoked successfully

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 2 revisions of this API.