Overview of permissions

Gain an understanding of all permissions on the Inkit platform and use this topic as your reference guide

Primarily, this is a reference topic. You will find an overview of all permissions here that you can assign to your users or your API keys. More than that, you’ll find explanations of what each permission does.

You may either read this reference guide thoroughly or parts of it. Be sure to come back to it whenever you feel uncertain about specific permissions.

Prerequisites:

  • You know about users and API keys
  • You have identified your API key needs
  • You know how to invite team members to your Inkit environment
  • You know how to set up API keys

Read more about:

Overview of all permissions

Permissions let users or systems perform behaviors and actions in your Inkit environment. They’re always tied to roles, and only through them can you assign your permissions.

Permission

Use

Folders.create

Lets the user or system create new folders

Folders.update

Lets the user or system modify the settings of existing folders

Folders.delete

Lets the user or system delete folders

Roles.create

Lets the user or system create new roles

Roles.retrieve

Lets the user or system pull data about existing roles

Roles.update

Lets the user or system modify and update existing roles

Roles.delete

Lets the user or system delete roles

Service-accounts.create

Lets the user or system create API keys

Service-accounts.retrieve

Lets the user or system pull data about API keys

Service-accounts.update

Lets the user or system modify and update API keys

Service-accounts.delete

Lets the user or system delete API keys

Accounts.retrieve

Lets the user or system retrieve information about the organizational account (your company info)

Accounts.update

Lets the user or system update your company information

Users.retrieve

Lets the user or system pull data about existing users

Users.update

Lets the user or system update user information

Users.activate

Lets the user or system activate users, granting them access to your environment

Users.deactivate

Lets the user or system deactivate users, revoking access to your environment

Renders.create

Lets the user or system generate PDFs

Renders.retrieve

Lets the user or system view existing PDFs in your environment

Renders.update

Lets the user or system modify existing PDFs

Renders.delete

Lets the user or system delete PDFs

Roles.permissions.retrieve

Lets the user or system pull permission data of roles

Roles.permissions.update

Lets the user or system modify permissions of roles

Api-keys.refresh

Lets the user or system (re)generate API key tokens

Events.retrieve

Lets the user or system view events

Shares.create

Lets the user or system share folders with other users or systems

Shares.delete

Lets the user or system revoke existing folder access from users or systems

Billing.invoices.list

Lets the user or system pull information about all previous invoices

Users.roles.update

Lets the user or system update roles

Users.management

Grants the user access to the user management tab in the web environment

Webhook-secret.refresh

Lets the user or system (re)generate webhook secrets

Webhooks.create

Lets the user or system create new webhooks

Webhooks.update

Lets the user or system update existing webhooks

Webhooks.delete

Lets the user or system delete webhooks


Did this page help you?