Getting Started

The Collaboration Permissions feature is only available to customers who have purchased the license for PSPDFKit Instant on a Server-backed setup. If you don’t have Instant and you want to try it, please get in touch with our sales team.

Once you have the license in place, you have to include the collaboration_permissions and user_id properties in your JSON Web Token (JWT).

Here’s how this might look:

const token = {
  ...otherProperties,
  collaboration_permissions: ["annotations:view:all", "annotations:edit:all"],
  user_id: "John"
};

The presence of collaboration_permissions and user_id is mandatory to enable Collaboration Permissions. We need the user_id property to define creator-based permissions.

If the Collaboration Permissions feature is enabled, all its associated actions are disabled unless you manually allow them. For example, collaboration_permissions: [] means users won’t be able to view any annotation, comment, or form field on a PDF. If collaboration_permissions isn’t present in the JWT, then Collaboration Permissions will automatically be disabled, and users will be able to perform every action without any restriction.

In the code mentioned above, you can see that collaboration_permissions is an array of permission strings. The permission strings define the permissions that have been granted to the user. Each string consists of three parts written in the <content-type>:<action>:<scope> format. We’ll take a look at the different possible values of content type, action, and scope in the Defining Permissions guide.